Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teamkweku/alx_travel_app
The alxtravelapp project is a real-world Django application that serves as the foundation for a travel listing platform
https://github.com/teamkweku/alx_travel_app
Last synced: 18 days ago
JSON representation
The alxtravelapp project is a real-world Django application that serves as the foundation for a travel listing platform
- Host: GitHub
- URL: https://github.com/teamkweku/alx_travel_app
- Owner: TeamKweku
- Created: 2024-12-03T19:03:24.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-03T19:20:04.000Z (about 1 month ago)
- Last Synced: 2024-12-03T20:18:13.210Z (about 1 month ago)
- Language: Python
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ALX Travel App
A Django-based travel application with comprehensive API functionality for managing travel listings. This project provides a robust backend system for handling travel-related data, featuring MySQL database integration, asynchronous task processing with Celery, and API documentation using Swagger.
## Features
- RESTful API for travel listings management
- Built with Django 4.2 and Django REST Framework
- MySQL database backend
- Celery for asynchronous tasks
- API documentation with Swagger
- CORS support for cross-origin requests
## Prerequisites
- Python 3.10+
- MySQL 8.0+
- RabbitMQ (for Celery)
- Pipenv (for dependency management)
## Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/alx_travel_app.git
cd alx_travel_app
```
2. Install dependencies using pipenv:
```bash
pipenv install
pipenv shell
```
3. Create a `.env` file in the project root with the following variables:
```
DJANGO_SECRET_KEY=your_secret_key
DB_NAME=your_db_name
DB_USER=your_db_user
DB_PASSWORD=your_db_password
DB_HOST=localhost
DB_PORT=3306
```
4. Apply database migrations:
```bash
python manage.py migrate
```
5. Run the development server:
```bash
python manage.py runserver
```
## API Documentation
The API documentation is available through Swagger UI at:
```
http://localhost:8000/swagger/
```
## Project Structure
```
alx_travel_app/
├── alx_travel_app/
│ ├── listings/ # Travel listings app
│ ├── settings.py # Project settings
│ └── urls.py # URL configurations
├── assets/ # Project assets
├── .env # Environment variables
├── manage.py
├── Pipfile # Dependencies
└── README.md
```
## API Endpoints
- `/swagger/` - API documentation
- `/admin/` - Django admin interface
## Technologies Used
- Django 4.2
- Django REST Framework
- MySQL
- Celery
- RabbitMQ
- drf-yasg (Swagger/OpenAPI)