https://github.com/raykipkorir/online-bus-booking-api
Online bus booking REST API
https://github.com/raykipkorir/online-bus-booking-api
django django-rest-framework python rest-api
Last synced: 6 months ago
JSON representation
Online bus booking REST API
- Host: GitHub
- URL: https://github.com/raykipkorir/online-bus-booking-api
- Owner: raykipkorir
- License: mit
- Created: 2023-05-01T20:16:27.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-24T18:54:37.000Z (over 2 years ago)
- Last Synced: 2024-04-24T20:23:12.250Z (over 2 years ago)
- Topics: django, django-rest-framework, python, rest-api
- Language: Python
- Homepage: https://online-bus-booking-api.onrender.com/
- Size: 150 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Online Bus Booking system API
Built with Django Rest Framework.
# Overview
Deployed successfully on Render -> [online-bus-booking-api](https://online-bus-booking-api.onrender.com/)
[Swagger documentation](https://online-bus-booking-api.onrender.com/api/v1/schema/swagger/)
[Redoc documentation](https://online-bus-booking-api.onrender.com/api/v1/schema/redoc/)
# Installation
Clone the repository in your terminal
```
git clone https://github.com/raykipkorir/online-bus-booking-api.git
```
Navigate into the repo
```
cd online-bus-booking-api
```
Create virtual environment
```
virtualenv venv
```
Activate virtual environment
- For windows users
```
venv\Scripts\activate
```
- For unix based systems
```
source venv/bin/activate
```
Install dependencies
```
pip install -r requirements.txt
```
Run migrations and server
```
make server
```
Note: Create .env file in the root directory to store your environment variables. Check .env.example to see environment variables that should be created.
# Endpoints
## Authentication
```
/api/token/ - to login users
```
```
/api/token/refresh/
```
## Users
```
/api/users/ - create and retrieve all users(admin only)
```
```
/api/users// - retrieve, update, delete specific user by id (admin only)
```
```
/api/users/me/ - retrieve, update, delete logged in user
```
```
/api/users/set_password/ - change password
```
```
/api/users/reset_password/ - reset password
```
## TripBus - Bus scheduled for a certain trip
```
/api/buses//trip-bus/ (admin only)- All trips for a certain bus
```
```
/api/buses//trip-bus// (admin only) - Retrieve, update or delete a trip for a certain bus
```
```
/api/trip-bus/?from=&to=&travel_date= - Query trips using start, destination and date of travel
```
## Ticket
```
/api/buses//trip-bus//tickets/ - Create ticket for a certain trip(all users) or list all tickets for a certain trip(admin only)
```
```
/api/buses//trip-bus//tickets/ - Retrieve ticket(all users) or update, delete ticket for a certain trip(admin only)
```
# Admin dashboard routes
## Bus
```
/api/buses/ - list and create bus (admin only)
```
```
/api/buses - retrieve, update and delete bus (admin only)
```
## Drivers
```
/api/drivers/ - list and create driver (admin only)
```
```
/api/drivers/ - retrieve, update and delete driver (admin only)
```
## Routes
```
/api/routes/ - list and create route (admin only)
```
```
/api/routes/ - retrieve, update and delete route (admin only)
```
## Admins
```
/api/admins/ - list and create new admins (admin only)
```
```
/api/admins/ - retrieve, update and delete admin (admin only)
```
## Contribute
Any minor contribution would be greatly appreciated
Happy coding 💚