Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codewithmuh/django-starter-kit
This repository contains a pre-configured development environment for Django-based applications, enabling developers to set up a robust development environment with a single command.
https://github.com/codewithmuh/django-starter-kit
celery celerybeat django django-rest-framework docker drf elasticsearch python starter-kit
Last synced: about 6 hours ago
JSON representation
This repository contains a pre-configured development environment for Django-based applications, enabling developers to set up a robust development environment with a single command.
- Host: GitHub
- URL: https://github.com/codewithmuh/django-starter-kit
- Owner: codewithmuh
- License: mit
- Created: 2023-12-25T07:54:55.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-27T09:18:53.000Z (9 months ago)
- Last Synced: 2024-02-27T11:01:12.793Z (9 months ago)
- Topics: celery, celerybeat, django, django-rest-framework, docker, drf, elasticsearch, python, starter-kit
- Language: Python
- Homepage: https://youtube.com/@codewithmuh
- Size: 48.8 KB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Django Starter Kit: Simplifying Development with Docker Compose, Celery, ElasticSearch, PostgreSQL, and Swagger
Welcome to the Django Starter Kit, a comprehensive setup designed to streamline Django development using Docker, Celery, ElasticSearch, PostgreSQL, and Swagger.
## Overview
This repository contains a pre-configured development environment for Django-based applications, enabling developers to set up a robust development environment with a single command.
## Features
- **Docker Integration**: Run your Django project and essential services in isolated containers for consistent development across different environments.
- **Components Included**:
- Django: High-level Python web framework for rapid development.
- PostgreSQL: Open-source relational database management system.
- ElasticSearch: Powerful search engine for efficient data indexing and querying.
- Celery & Celery Beat: Asynchronous task queue with a scheduler for background tasks.
- Swagger (OpenAPI): Generates interactive API documentation for easy understanding and testing of endpoints.
- **Simplified Setup Process**: No need to individually install Python, PostgreSQL, ElasticSearch, etc. Run a single command to initialize the entire development environment.
## Getting Started
To get started with the Django Starter Kit:
1. **Clone the Repository**: `git clone https://github.com/codewithmuh/django-starter-kit.git`
2. **Configure Environment Variables**: Modify the `local.backend.env` available in build-process folder , we will use this file to customize settings according to your requirements.
3. **Run Setup Command**:
```bash
docker compose -f "./build-process/docker-compose-django-backend.yml" up -d --build
```
## Usage
With the development environment up and running, start coding your Django application without worrying about individual service installations or configurations. Focus on building your application and leave the rest to the Dockerized setup!
## Contribution Guidelines
Contributions to the Django Starter Kit are highly encouraged! Follow these guidelines to contribute:
### Note: Make sure the Docker desktop is installed and running on your system. You can download it from the official website of dockerhub.
1. Fork the repository.
2. Create a new branch: `git checkout -b feature/your-feature`.
3. Make your changes and commit them: `git commit -m 'Add your feature'`.
4. Push to the branch: `git push origin feature/your-feature`.
5. Submit a pull request!
## License
This project is licensed under MIT License, granting you the freedom to use, modify, and distribute the code.
## Acknowledgements
Special thanks to codewithmuh for creating this incredible Django Starter Kit and simplifying the development process.
## Support
