cookiecutter-django

(★ 13,597)

Cookiecutter Django is a framework for jumpstarting production-ready Django projects quickly.

File Explorer

Download Latest Version (.zip)

- - bug.md
  - feature.md
  - paid-support.md
  - question.md
- - align-versions.yml
  - ci.yml
  - dependabot-uv-lock.yml
  - django-issue-checker.yml
  - issue-manager.yml
  - pre-commit-autoupdate.yml
  - update-changelog.yml
  - update-contributors.yml
- changelog-template.md
- CONTRIBUTORS-template.md
- contributors.json
- dependabot.yml
- FUNDING.yml
- PULL_REQUEST_TEMPLATE.md
- - project-generation-options.rst
  - settings.rst
- - developing-locally-docker.rst
  - developing-locally.rst
  - generate-project-block.rst
- - cloud-storage.rst
  - deployment-on-heroku.rst
  - deployment-on-pythonanywhere.rst
  - deployment-with-docker.rst
- - docker-postgres-backups.rst
  - document.rst
  - linters.rst
  - testing.rst
  - websocket.rst
- - faq.rst
  - troubleshooting.rst
- - contributing.md
  - generative-ai.md
  - maintainer-guide.md
- - .gitkeep
- - mailgun.rst
- __init__.py
- conf.py
- index.rst
- make.bat
- Makefile
- __init__.py
- post_gen_project.py
- pre_gen_project.py
- __init__.py
- create_django_issue.py
- node_version.py
- python_dependency_version.py
- update_changelog.py
- update_contributors.py
- __init__.py
- test_bare.sh
- test_cookiecutter_generation.py
- test_docker.sh
- test_generate.ps1
- test_hooks.py
- - bash_history
  - bashrc.override.sh
  - devcontainer.json
- - dependabot.yml
- - misc.xml
  - modules.xml
  - vcs.xml
  - webResources.xml
  - workspace.xml
  - {{cookiecutter.project_slug}}.iml
- - post_compile
- - __init__.py
  - api.py
  - api_router.py
  - asgi.py
  - celery_app.py
  - urls.py
  - websocket.py
  - wsgi.py
- - __init__.py
  - conf.py
  - howto.rst
  - index.rst
  - make.bat
  - Makefile
  - users.rst
- - README.md
- - base.txt
  - local.txt
  - production.txt
- - __init__.py
  - test_merge_production_dotenvs_in_dotenv.py
- - install_os_dependencies.sh
  - install_python_dependencies.sh
  - requirements-bionic.apt
  - requirements-bookworm.apt
  - requirements-bullseye.apt
  - requirements-buster.apt
  - requirements-focal.apt
  - requirements-jammy.apt
  - requirements-jessie.apt
  - requirements-noble.apt
  - requirements-stretch.apt
  - requirements-trusty.apt
  - requirements-xenial.apt
- - common.config.js
  - dev.config.js
  - prod.config.js
- - __init__.py
  - conftest.py
- .dockerignore
- .drone.yml
- .editorconfig
- .gitattributes
- .gitignore
- .gitlab-ci.yml
- .pre-commit-config.yaml
- .python-version
- .readthedocs.yml
- .travis.yml
- CONTRIBUTORS.txt
- COPYING
- docker-compose.docs.yml
- docker-compose.local.yml
- docker-compose.production.yml
- gulpfile.mjs
- justfile
- LICENSE
- manage.py
- merge_production_dotenvs_in_dotenv.py
- package.json
- Procfile
- pyproject.toml
- README.md
- uv.lock
.editorconfig
.gitattributes
.gitignore
.pre-commit-config.yaml
.pyup.yml
.readthedocs.yaml
AGENTS.md
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
CONTRIBUTORS.md
cookiecutter.json
LICENSE
pyproject.toml
README.md
SECURITY.md
tox.ini
uv.lock

# Installation Guide

1. Get the code

git clone https://github.com/cookiecutter/cookiecutter-django

Downloads the entire project code from GitHub to your computer.

cd cookiecutter-django

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose -f {{cookiecutter.project_slug}}/docker-compose.docs.yml up -d --build

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

cd {{cookiecutter.project_slug}}

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

pip install .

Installs the package published on PyPI directly — no need to clone the source.

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.