{"id":16417357,"url":"https://github.com/godd0t/django-docker-quickstart","last_synced_at":"2025-10-26T20:30:30.511Z","repository":{"id":163397414,"uuid":"638815100","full_name":"godd0t/django-docker-quickstart","owner":"godd0t","description":"Your all-in-one Django-Docker starter kit. Pre-configured services including PostgreSQL, Redis, Celery, with Nginx and Traefik for production. Streamlined development with included tools for testing and formatting.","archived":false,"fork":false,"pushed_at":"2024-04-11T13:40:48.000Z","size":41,"stargazers_count":241,"open_issues_count":0,"forks_count":33,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-02-07T10:46:44.414Z","etag":null,"topics":["coverage","django","django-docker","docker","docker-compose","nginx","pytest","traefik"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/godd0t.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-10T07:00:30.000Z","updated_at":"2025-01-20T21:36:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"73917dfd-cb03-4fa8-a172-50583d7c042a","html_url":"https://github.com/godd0t/django-docker-quickstart","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godd0t%2Fdjango-docker-quickstart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godd0t%2Fdjango-docker-quickstart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godd0t%2Fdjango-docker-quickstart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godd0t%2Fdjango-docker-quickstart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/godd0t","download_url":"https://codeload.github.com/godd0t/django-docker-quickstart/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238394323,"owners_count":19464583,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["coverage","django","django-docker","docker","docker-compose","nginx","pytest","traefik"],"created_at":"2024-10-11T07:11:28.037Z","updated_at":"2025-10-26T20:30:25.233Z","avatar_url":"https://github.com/godd0t.png","language":"Python","readme":"# Django Docker Quickstart\n\nThis quickstart provides an easy way to initiate a Django project using Docker. It comes with pre-configured services including PostgreSQL, Redis, Celery (worker and beat), Nginx, and Traefik, ready to run a Django web application. Additionally, it provides a few handy shortcuts for easier development.\n\n---\n\n## Features 🚀\n\n- **Django** web application framework\n- **PostgreSQL** database\n- **Redis** in-memory data structure store\n- **Celery** worker and beat services for running background tasks asynchronously\n- **Nginx** web server for serving static and media files, and proxying requests to the Django application\n- **Traefik** reverse proxy for routing requests to the appropriate service and providing SSL termination\n\n## Included Packages and Tools 🛠️\n\n- **Pytest**: Testing framework\n- **Pytest Sugar**: A pytest plugin for a better look\n- **Pytest Django**: A pytest plugin providing useful tools for testing Django applications\n- **Coverage**: Test coverage tool\n- **Ruff**: Linter\n- **Black**: Code formatter\n\n## Requirements 📋\n\n- Docker \u0026 Docker Compose - [Install and Use Docker](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-20-04)\n- Python 3.10 or higher\n- Make (optional for shortcuts)\n\n---\n\n## Getting Started 🏁\n\n1. **Clone the repository:**\n    ```bash\n    git clone https://github.com/godd0t/django-docker-quickstart.git\n    ```\n\n2. **Change directory into the project:**\n    ```bash\n    cd django-docker-quickstart\n    ```\n\n3. **Copy the `env.example` file to `.env` and update the values as needed:**  \n\n   - **For Linux/macOS:**  \n     ```bash\n     cp env.example .env\n     ```\n   - **For Windows (Command Prompt):**  \n     ```cmd\n      Copy-Item -Path env.example -Destination .env\n     ```\n\n---\n\n## Initial Setup ⚙️\n\n### Development Prerequisites\n\n1. **Create a virtual environment:**\n    ```bash\n    python -m venv venv\n    ```\n\n2. **Activate the virtual environment:**\n    ```bash\n    source venv/bin/activate\n    ```\n\n3. **(Optional) Install the development requirements specific to your IDE for enhanced functionality and support.**\n    ```bash\n    pip install -r src/requirements.dev.txt\n    ```\n\n4. **Build the image and run the container:**  \n   \n   - If buildkit is not enabled, enable it and build the image:\n     ```bash\n     DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1 docker-compose -f docker-compose.yml up --build -d\n     ```\n   \n   - If buildkit is enabled, build the image:\n     ```bash\n     docker-compose -f docker-compose.yml up --build -d\n     ```\n   \n   - Or, use the shortcut:\n     ```bash\n     make build-dev\n     ```\n\nYou can now access the application at http://localhost:8000. The development environment allows for immediate reflection of code changes.\n\n### Production Setup\n\n1. **Build the image and run the container:**  \n\n   - If buildkit is not enabled, enable it and build the image:\n     ```bash\n       DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1 docker-compose -f docker-compose.prod.yml up --build -d\n     ```\n\n   - If buildkit is enabled, build the image:\n     ```bash\n      docker-compose -f docker-compose.prod.yml up --build -d\n     ```\n   - Or, use the shortcut:\n     ```bash\n       make build-prod\n     ```\n\n---\n\n## Shortcuts 🔑\n\nThis project includes several shortcuts to streamline the development process:\n\n- **Create migrations:**\n    ```bash\n    make make-migrations\n    ```\n\n- **Run migrations:**\n    ```bash\n    make migrate\n    ```\n\n- **Run the linter:**\n    ```bash\n    make lint\n    ```\n\n- **Run the formatter:**\n    ```bash\n    make format\n    ```\n\n- **Run the tests:**\n    ```bash\n    make test\n    ```\n\n- **Create a super user:**\n    ```bash\n    make super-user\n    ```\n\n- **Build and run dev environment:**\n    ```bash\n    make build-dev\n    ```\n\n- **Build and run prod environment:**\n    ```bash\n    make build-prod\n    ```\n---","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgodd0t%2Fdjango-docker-quickstart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgodd0t%2Fdjango-docker-quickstart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgodd0t%2Fdjango-docker-quickstart/lists"}