Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 1.18 KB

README.md

File metadata and controls

49 lines (30 loc) · 1.18 KB

SAHAJ YATRA API

SAHAJ YATRA API, aims to provide a interface to create, manage and update the user and admin status for a digital transportation system.

This project emphasizes and implements the following major features:

Using the API

You can locally setup the system or just use the API hosted on onrender, for which the url is SAHAJ YATRA API

Local Setup

  1. Clone the repository to your local environment.

    git clone https://github.com/Senor101/Sahaj_Yatra_API.git

  2. Head inside the newly setup Sahaj_Yatra_API folder.

    cd Sahaj_Yatra_API

  3. Install the required dependencies.

    npm install

  4. Setting up environment variables, create a .env file in the root of the new folder and with reference to .env.example file setup the environment variables.

  5. Running the server.

    npm start

    OR, to run development server

    npm run dev

  6. Head over to http://localhost:8000/api/v1 and voila, you got the SAHAJ YATRA API server up and running.

API

For interacting with the api, refer to SAHAJ YATRA API DOCS.