-
Make sure you have
nodejs
installed.- yarn install - Create/configure `.env` environment with the following credentials MONGODB_URI - Run `npm run start-dev` to start the server development
- To test or consume the API locally, you can make use of Postman to simulate a front-end client.
- You can also test by running
npm test
.
All API requests are made by sending a secure HTTPS request using one of the following methods, depending on the action being taken:
POST
Create a dataGET
Get a data or data
Each response will be returned with one of the following HTTP status codes:
200
OK
The request was successful201
OK
created successfully400
Bad Request
There was a problem with the request (security, malformed)500
Internal serval error
There was a problem with the network or database