Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/victorpbilbao/driver
https://github.com/victorpbilbao/driver
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/victorpbilbao/driver
- Owner: VictorPBilbao
- License: agpl-3.0
- Created: 2024-07-25T03:15:01.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-08-15T13:23:31.000Z (5 months ago)
- Last Synced: 2024-08-15T16:44:31.096Z (5 months ago)
- Language: Python
- Size: 61.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚗 Rental Company Driver API
The Rental Company Driver API is a comprehensive solution designed for rental companies to manage their operations efficiently and publish their rates through an open API. This enables Online Travel Agencies (OTAs) and other travel brokers to easily access and consume the information. The API is built using FastAPI, offering high performance and easy scalability.
## 🌟 Features
- **Store Management:** Allows rental companies to manage their store information, including creating new stores and retrieving details of existing stores.
- **Rate Publishing:** Enables rental companies to publish their rental rates, making them accessible to OTAs and travel brokers.
- **Query Stores:** Supports querying stores based on specific criteria, such as active status.
- **Open API:** Provides an open API for OTAs and travel brokers to consume the published rates and store information.
## 🚀 Getting Started
### Prerequisites
Before you begin, ensure you have the following installed:
- Python 3.8 or higher 🐍
- pip (Python package installer) 📦
### Installation
1. Clone the repository:
```bash
git clone https://github.com/VictorPBilbao/driver.git
```
2. Navigate to the project directory:
```bash
cd driver
```
3. **[OPTIONAL]** Create a virtual environment:
```bash
python -m venv venv
```
and activate it:
```bash
venv\Scripts\activate
```
4. **[OPTIONAL]** Upgrade pip:
```bash
python -m pip install --upgrade pip
```
5. Install the project dependencies:
```bash
pip install -r requirements.txt
```
6. Start the FastAPI server:
```bash
fastapi dev main.py
```
7. Access the API documentation at your [localhost](http://127.0.0.1:8000)
8. **[OPTIONAL]** Open the API documentation in your browser:
- 📄 Swagger UI: `/docs`
- 📘 ReDoc: `/redoc`
## 🤝 Contributing
Contributions are welcome! Please feel free to submit pull requests or open issues to suggest improvements or add new features.
## 📜 License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.