Installation

1. Install dependencies --- npm install

2. Create a new file .env if it doesn't exist and copy the contents of env.dev into it to be able to run your server on production environment.

3. Then you need to provide values for the configuration env files at the src/config/env directory.

Running the server locally.

1. Start up the server - Run npm start | npm run dev

2. Server should be running on http://localhost:4000/ by default

Routes

| ----------------------------------------------------------------|----------------------------------------- | ----------------------------------- | [POST]   /api/auth/sign-up | Create a new account | none
| [POST]   /api/auth/sign-in | User sign in | none
| [POST]   /api/auth/request-email-verification | Resend verfication email | none
| [POST]   /api/auth/verify-email | Email verification | none
| [POST]   /api/auth/request-password-reset | Sends a request password email | none
| [POST]   /api/auth/reset-password | Reset password form handler | none
| [POST]   /api/users | Create a user |
| [GET]   /api/users | Get all users | Admin
| [GET]   /api/users/:userId | Get a user |
| [UPDATE]   /api/users/::userId | Update a user | User
| [DELETE]   /api/users/:userId | Delete a user | Admin