Django Boilerplate is a template to simplify the initial setup of Django projects, created by @abdi-bb. It includes common configurations, dependencies, and best practices to save time when starting new Django projects.
- Basic Setup: Pre-configured Django project with common settings.
- Dependency Management: Utilizes Docker for managing dependencies and containerization.
- Documentation: Comprehensive documentation to guide you through using the boilerplate.
- Testing and CI: Includes a suite of tests and continuous integration setup.
- Community Support: Open to contributions and community feedback.
To use Django Boilerplate, simply clone the repository and follow the setup instructions in the documentation.
Note: This boilerplate utilizes Docker for managing dependencies and containerization. Ensure Docker is installed on your system before proceeding.
git clone https://github.com/abdi-bb/django-boilerplate.git
cd django-boilerplate
cp .env.example .env To run the project in development mode, follow these steps:
-
Build and start the Docker containers:
docker-compose up --build
-
Access the API: Open your browser and navigate to http://localhost:8000/api
To run the project in production mode, follow these steps:
-
Build and start the Docker containers using the production configuration:
docker-compose -f docker-compose.prod.yml up --build
-
Access the API: Open your browser and navigate to http://localhost/api
Check out the documentation for detailed usage instructions and configuration options.
We welcome contributions from the community! Please read the contribution guidelines before getting started.
This project is licensed under the MIT License. Feel free to use, modify, and distribute the code for both commercial and non-commercial purposes.