https://github.com/wazedkhan/vehicle-allocation-system
https://github.com/wazedkhan/vehicle-allocation-system
fastapi mongodb python
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/wazedkhan/vehicle-allocation-system
- Owner: WazedKhan
- License: apache-2.0
- Created: 2024-10-22T15:35:00.000Z (over 1 year ago)
- Default Branch: development
- Last Pushed: 2024-11-05T19:16:09.000Z (over 1 year ago)
- Last Synced: 2025-03-26T01:33:04.881Z (over 1 year ago)
- Topics: fastapi, mongodb, python
- Language: Python
- Homepage:
- Size: 49.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vehicle-Allocation-System
## API Collection
This project is an API collection that manages vehicle and employee allocations using FastAPI and MongoDB. It allows for the creation, retrieval, updating, and deletion of allocations.
## Prerequisites
- Docker
- Docker Compose
- Python 3.12 (for local development)
## Getting Started with Docker
1. **Clone the Repository**
```bash
git clone https://github.com/WazedKhan/Vehicle-Allocation-System
cd Vehicle-Allocation-System
## Build the Docker Images and Run the Services
Use the following command to build the Docker images:
- ```docker-compose build```
- ```docker-compose up```
## Access the Application
Once the services are running, you can access the FastAPI application at http://localhost:8000.
API Documentation
The API documentation is available at http://localhost:8000/docs, where you can explore the endpoints and their functionality.
## API Collection
An API collection is provided in the project to help you test the endpoints. You can import it into your favorite API testing tool (like Postman) for easy exploration and testing of the API functionalities.
POSTMAN API collection loc:
- Vehicle-Allocation-System/API-Collections/postman_collection.json