This project provides a Django-based RESTful API template bundled with Docker for easy setup and deployment. It's designed to streamline the development process and ensure a consistent environment across different systems.
- Docker installed on your machine.
-
Clone the Repository:
git clone https://github.com/your-username/your-repository.git cd your-repository
-
Create Environment Variables:
Create a
.env
file in the root of the project and configure your environment variables. You can use the provided.env
file as a template. -
Start the Application:
docker-compose up -d --no-deps --build
This command will build the Docker containers and start the Django application. The
-d
flag runs the containers in the background. -
Access the API:
Once the containers are running, you can access the Django API at http://localhost:8000.
-
Stop and Remove Containers:
docker-compose down -v
This command will stop and remove the running containers, along with associated volumes.
Run Django tests to ensure the API functionalities:
docker-compose exec web python manage.py test
This project drew inspiration from earthcomfy/django-docker-template.
Contributions are welcome! Feel free to submit issues, suggest improvements, or open pull requests.
This project is licensed under the MIT License.