Skip to content

Latest commit

 

History

History
78 lines (50 loc) · 1.67 KB

README.md

File metadata and controls

78 lines (50 loc) · 1.67 KB

Cosuno Rest API

This Sample API retrieves contractors and their specialities.

styler gif

View Demo

Libraries

Features

REST API created with node, express, typescript Endpoints:

  • GET /api/contractors -> get all contractors
  • GET /api/specialities -> get all specialties

Installation Steps

Please before run the app, take into account to have a nodejs installed in your local.

  1. Clone the repository
git clone https://github.com/ravisankarchinnam/cosuno-app.git
  1. Change the working directory
cd server
  1. Install dependencies
yarn install
  1. Create .env file in root and add your variables
PORT= YOUR_PORT
  1. Run the app
yarn run dev

You are all set! Open localhost:3030 to see the app.

yarn run prod - which generates a dist folder with all the files ready for the deployment in the same server folder.

Deployment

This API is deployed to heroku along with Swagger API Documentation, please use this endpoint https://cosuno-app.herokuapp.com

Enhancements

  1. Integrate API with real database.
  2. Implement Search Features (limit, sort, pagination, etc.)
  3. Implement Session management
  4. Implement CRUD Operations for Contractors
  5. Implement CRUD operations for specialities
  6. Implement Bidding system API

Author

Ravisankar Chinnam