this is the repo for the hng stage 3 backend assessment given to team giants.
To clone this repository, you can head over to GitHub Repository. the major requirements for this API is shown below
- NodeJS (npm)
- MySQL
- .env (Environment Variables)
Variable | Data Type | Allowed Values |
---|---|---|
PORT | Number | Default: 3001 |
NODE_ENV | String | production | development |
DB_URL | String | mongodb url |
These variables are required and the API cannot work well without them! 😂
first run npm install
to install the necessary dependencies
after the dependencies are installed, type npm start
and visit the api from http://localhost:{port}/
. default port is 3001
All endpoints accept JSON objects and returns JSON objects
Footnotes
-
Happy coding 👋 ↩