Make company global travel and accommodation easy and convenient for the strong workforce of savvy members of staff, by leveraging the modern web.
This project uses a .editorconfig file to help maintain consistent coding styles for the developers working on this project across various editors and IDEs. Follow this link to see if your editor requires a plugin for this feature and to guide you in installing the required plugin if it does.
To install and run the app with Docker, you must have Docker installed and running on your computer. Follow this link to guide you in installing and setting up Docker on Windows 10, MacOS or Linux. Then clone this repo and run this command to build the Docker image.
docker build -t <docker-image-name> .
Where <docker-image-name> is the name you choose to give to the Docker image. For example,
docker build -t iceman-backend .
After the build process has been completed, run this command to run the app from the Docker image.
docker run -p 3000:3000 <docker-image-name>
For example,
docker run -p 3000:3000 iceman-backend
| HTTP VERB | ENDPOINTS | DESCRIPTION |
|---|---|---|
| POST | /api/v1/auth/signup | Creates user account |
| POST | /api/v1/auth/login | Logs user in |
| GET | /api/v1/users/profile | Gets user profile information |
| PATCH | /api/v1/users/profile | Updates user profile information |
| GET | /api/v1/auth/verify | Verify user email |
| GET | /api/v1/auth/resend_verification_link | Resend verification link |
| POST | /api/v1/auth/forgot_password | Send password reset token |
| PATCH | /api/v1/auth/reset_password/:token | Reset user password |
| GET | /api/v1/auth/facebook | Authenticate user using Facebook |
| GET | /api/v1/auth/google | Authenticate user using Google |
| PATCH | /api/v1/auth/assign_role | Assign user role |
| POST | /api/v1/requests/multi-city | Allow user to make multi city request |
| POST | /api/v1/requests/one-way | Allow user to make one way request |
| POST | /api/v1/requests/return | Create a return trip |
| PATCH | /api/v1/requests/:id | Updates trip requests |
| GET | /api/v1/requests | Retrieve user requests |
| GET | /api/v1/requests/return | Create a return trip |
| GET | /api/v1/requests/pending | Avail open requests for approval |
| PATCH | /api/v1/requests/:id/respond | Approve or Reject a travel request |
The documentation of this API can currently be found here