🌍 alx_travel_app: Your Gateway to Seamless Travel Listings 🚀

✨ Project Overview
Welcome to the alx_travel_app! This project is a robust, real-world Django application designed to be the foundation for a powerful travel listing platform. This repository represents the crucial first milestone for the ALX Backend Web Pro-Development curriculum, focusing on a production-ready setup from the ground up.
Our mission is to build a scalable and secure backend that demonstrates industry-standard practices, preparing students to tackle complex, real-world development challenges.
🌟 Key Features
- Django-Powered Backend: Built on the reliable and feature-rich Django framework.
- RESTful API: Developed with Django REST Framework for clean, well-structured API endpoints.
- MySQL Database: Utilizes a robust relational database for secure and efficient data management.
- API Documentation: Integrated with Swagger UI (
drf-yasg) for automatic, interactive, and beautifully documented API endpoints.
- Secure Configuration: Employs
django-environ to handle sensitive data via .env files, ensuring secrets are never committed to the repository.
- CORS Headers: Configured with
django-cors-headers for seamless cross-origin resource sharing.
🚀 Getting Started
Follow these simple steps to get the project up and running on your local machine.
Prerequisites
Make sure you have the following installed:
- Python 3.x
- MySQL Server
- Git
Installation
- Clone the Repository
git clone [https://github.com/Dwaynemaster007/alx_travel_app.git](https://github.com/Dwaynemaster007/alx_travel_app.git)
cd alx_travel_app
- Set Up the Virtual Environment
python3 -m venv venv
source venv/Scripts/activate # On Windows using Git Bash
- Install Dependencies
pip install -r requirements.txt
- Database Configuration
Create a
.env file in the root directory of the project and add your MySQL credentials.
DB_NAME=your_database_name
DB_USER=your_username
DB_PASSWORD=your_password
DB_HOST=127.0.0.1
DB_PORT=3306
SECRET_KEY=your_secret_key
DEBUG=True
- Run Migrations
python manage.py migrate
- Start the Server
python manage.py runserver
Your API will now be running at http://127.0.0.1:8000/.
📚 API Documentation
Explore all available API endpoints directly from your browser!
🤝 Contribution
This project is a continuous journey. We welcome contributions, bug reports, and feature requests. Feel free to open an issue or submit a pull request!
📜 License
This project is licensed under the BSD License. See the LICENSE file for details.
Made with ❤️ by Dwayne Master 007 for the ALX Backend Web Pro-Development curriculum.