Installation
Choose your path: Quick (download ready project), Full (complete setup), or Manual (fork & customize).
Quick Start
curl -L https://djangocfg.com/install.sh | shInteractive Installer
Install Django-CFG
Quick, Full, or Manual - Choose your installation path
Choose your platform
Auto-detected based on your system
What you'll get:
- Quick Install: Download ready project (no setup)
- Full Install: Complete setup with dependencies & Docker services
- Manual Install: Instructions to fork & clone repository
⭐ Don't forget to fork and star the repository!
Fork on GitHubInstallation Features
Poetry preferred, pip fallback available
Services are optional - installer won't fail
Database migrations run after services start
The installer offers three installation types:
- Quick Install - Download ready-to-use project (no setup required)
- Full Install - Complete setup with all dependencies
- Manual Install - Instructions to fork and clone the repository
Requirements
| Tool | Version | Note |
|---|---|---|
| Python | 3.12+ | Required |
| Poetry or pip | Latest | Poetry preferred, pip fallback available |
| Node.js | 20+ | For frontend (pnpm will be needed) |
| Docker | Latest | Optional - for local services (Redis, PostgreSQL, Centrifugo) |
Docker is optional. If not available, the installer will skip local services and you can set them up manually later.
Installation Options
Quick Install
Run the installer script (auto-detects your OS and architecture):
macOS / Linux
curl -L https://djangocfg.com/install.sh | shThe installer will guide you through:
- Installation type selection
- Project name input
- Dependency installation (Python + Frontend)
- Database migrations
- Optional Docker services setup
Manual Installation
Prefer to do it manually? Here’s the step-by-step process:
With Poetry
# 1. Fork & clone the repository
git clone [email protected]:YOUR_USERNAME/django-cfg.git
cd django-cfg/solution/projects/django
# 2. Install Python dependencies
poetry install
# 3. Configure environment
# Edit settings in ./api/environment/.env
# 4. Run migrations (if using local PostgreSQL)
poetry run python manage.py migrate
# 5. Run Django server
poetry run python manage.py runserver
# 6. Install frontend dependencies
cd ../../frontend/apps/admin
pnpm installHeadless Mode (CI/CD)
For automation and CI/CD pipelines:
./djangocfg-installer --headless --config '{"project_name":"my-app","install_type":"full"}'Configuration Options
| Field | Default | Description |
|---|---|---|
project_name | required | Project directory name |
install_type | quick | Installation type: quick or full |
db_name | djangocfg | PostgreSQL database name |
db_user | postgres | PostgreSQL user |
db_password | password | PostgreSQL password |
Simulation Mode
Preview what will happen without making changes:
./djangocfg-installer --simulateWhat Gets Installed
Full Install Mode
- ✅ Downloads project template
- ✅ Generates
.envconfiguration files - ✅ Installs Python dependencies (Poetry or pip fallback)
- ✅ Installs Frontend dependencies (pnpm)
- ✅ Optionally starts Docker services (PostgreSQL, Redis, Centrifugo, RQ)
- ✅ Runs database migrations (after services start)
Quick Install Mode
- ✅ Downloads ready-to-use project ZIP
- ✅ Extracts to your chosen directory
- ℹ️ Dependencies NOT installed (you run
poetry installandpnpm installmanually)
Troubleshooting
Docker Not Running
# If you get "Docker is not running" warning:
# 1. Start Docker Desktop, or
# 2. Skip services and use SQLite for development:
# In .env file:
DATABASE__URL=sqlite:///db.sqlite3The installer does not fail if Docker is unavailable. Services are optional.
Verify Installation
Check the installer version:
./djangocfg-installer --versionStart your Django server:
cd my-project/projects/django
poetry run python manage.py runserver
# Visit http://localhost:8000Support the Project
⭐ Star and Fork the repository on GitHub: github.com/markolofsen/django-cfg
Help us grow the community!
Next Steps
- First Project - Build your first Django-CFG app
- Configuration - Learn about settings and environment
- Sample Project - Explore a production example