hussu010 / phishit-api Goto Github PK

View Code? Open in Web Editor NEW

0.0 1.0 0.0 609 KB

book a guide, search for trekking designations and become a guide on the Himalayas

Home Page: https://phishit-api-dev.tnbswap.com/docs

Dockerfile 0.12% TypeScript 98.95% Makefile 0.37% JavaScript 0.05% Shell 0.51%

digitalocean docker expressjs nginx nodejs typescript

phishit-api's Introduction

Phish.it

Project Structure

src - Source code for the application

scripts - Scripts to automate tasks

Dockerfile - Dockerfile for the application

Makefile - Makefile to automate tasks

package.json - Node.js package file

swagger.json - Swagger file for the application

src/tests - Tests for the application

src/seed - Seed data for the application

src/users - users feature module

src/auth - auth feature module

src/bookings - bookings feature module

src/adventures - adventures feature module

src/common - common feature module

src/common/config - configuration for the application

src/backoffice - admin feature module

Development Guide

Prerequisites

Docker

Setup

Clone the repository
Build the docker image

make build-development

Start the development server

make start-development

Open the browser and navigate to http://localhost:5000/docs

Happy Coding.

phishit-api's People

Contributors

Watchers

phishit-api's Issues

feat: my bookings

as a user, I wish to be able to view all my upcoming bookings
as a guide, I wish to be able to list out all the upcoming bookings of users alongside the details

feat: become a guide

As a user, I wish to be able to apply to become a guide.
As phishit, I wish be to able to verify the users and add them as a guide to different packages.

swagger docs: /guide-request endpoint

add authorization on user endpoints

feat: user roles

as a website admin, i wish to be able to add users and assign roles to them

feat: GET /adventures endpoint

list available guides for selected start date and package

only allow super admins to delete packages + adventures

feat: users/me endpoint

return information of the user alongside role

seed real data for internal defense

feat: guides and packages

as a guide, I wish to be able to enrolled on packages of adventures so that users can book me
As a user, I wish to be able to list out guides on the packages available on the adventure

feat: POST /adventures endpoint

As a admin, I wish to be able to seed destinations so that the users will be able to view destinations
as a guide, I wish to be able support destinations.
as a user, I wish to be able to view the list of destinations and view guides on that destination.

accessToken

returns:

refreshToken

method (GOOGLE, PHONE)
phoneNumber
code