https://github.com/senor101/sahaj_yatra_api
A digitlal web based bus fare management system to use bus services for consumers and comprehensive reports and analytics for the Company adopting the system.
https://github.com/senor101/sahaj_yatra_api
mongoose passport-jwt-authentication typescript-nodejs
Last synced: 24 days ago
JSON representation
A digitlal web based bus fare management system to use bus services for consumers and comprehensive reports and analytics for the Company adopting the system.
- Host: GitHub
- URL: https://github.com/senor101/sahaj_yatra_api
- Owner: Senor101
- Created: 2023-12-03T06:44:03.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-08T14:52:14.000Z (about 2 years ago)
- Last Synced: 2025-03-16T02:20:10.656Z (about 1 year ago)
- Topics: mongoose, passport-jwt-authentication, typescript-nodejs
- Language: TypeScript
- Homepage: https://sahaj-yatra-api.onrender.com
- Size: 327 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://sahaj-yatra-api.onrender.com/api/v1)
### Local Setup
1. Clone the repository to your local environment.
```bash
git clone https://github.com/Senor101/Sahaj_Yatra_API.git
```
2. Head inside the newly setup `Sahaj_Yatra_API` folder.
```bash
cd Sahaj_Yatra_API
```
3. Install the required dependencies.
```bash
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.
```bash
npm start
```
OR, to run development server
```bash
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](DOCS.md).