dj-scaffold is your ultimate CLI companion for rapidly scaffolding modern, production-ready Django applications. Inspired by tools like create-next-app, it gives you an interactive, zero-headache setup experience so you can start coding your business logic instantly.
- ⚡ Interactive Setup: Answer a few prompts and your project is ready.
- 🐳 Docker-Ready: Instantly containerized with zero setup required.
- 🛡️ Secure & Configured: CORS, CSP, and JWT auth out of the box.
- 🏗️ Modern Architecture: Enforces a scalable Service Layer pattern for your apps.
Install the CLI globally or in your virtual environment:
pip install dj-scaffold-imhotep-
Create your project:
dj-scaffold create
(Answer the prompts to choose your database and API framework).
-
Start the server:
cd <your-project-name> docker compose up -d --build
(This automatically runs migrations and creates a superuser!)
-
Add a new app:
dj-scaffold startapp
(This wires a new app into your project using the Service Layer architecture).
Dive deep into what dj-scaffold does under the hood. Check out our detailed documentation guides:
- ⌨️ CLI Commands Reference – Full list of commands and interactive menus.
- 📖 Project Overview – Understand what gets generated and why.
- 🔑 Default Admin & Credentials – Learn how the auto-superuser works.
- 🗄️ Database Options – Details on PostgreSQL, MySQL, and SQLite setups.
- 📡 API Framework Flavors – Learn about DRF, Django Ninja, and Standard Django setups.
- 🏗️ Architecture Layouts – Deep dive into the Service Layer pattern vs Standard layout.
To set up the CLI tool for local development:
-
Clone the repository:
git clone https://github.com/Imhotep-Tech/dj-scaffold.git cd dj-scaffold -
Install in editable mode with development dependencies:
pip install -e .[dev]
-
Run the test suite:
pytest -v
If you want to contribute to the project, please see our CONTRIBUTING.md file.