/demo-api

This is a demo assessment project

Primary LanguageJavaScript

DEMO API - INSTALLATION

Step 1: Clone the repository.

Step 2: cd into the cloned folder | cd demo-api.

DEMO API - Running the project locally

Step 1: npm install.

Step 2: Create.env file using the command touch .env in the root folder.

Step 3: Add API_PORT=3000 inside the .env that was created.

Step 4: npm run dev.

Step 4: Go to http://localhost:3000.

You will be redirected to the docs page of the API.

DEMO API - Running Test

  • To run test , type the command npm test
  • To run test coverage , type the command npm run test:coverage

Docs URL

http://localhost:3000

API Endpoint URL

http://localhost:3000/api/

Hosted API endpoint URL

https://demo-api-endpoint.herokuapp.com/api/

Hosted API Docs URL

https://demo-api-endpoint.herokuapp.com/docs/v1