Documentation
Quick Start Guide
Get up and running in minutes with this step-by-step guide.
Prerequisites
- Python 3.13+ or 3.14+ installed
- pip package manager
- (Optional) Docker and Docker Compose v2
Local Installation
- Create a virtual environment:
$ python3 -m venv venv $ source venv/bin/activate
- Install dependencies:
$ pip install -r requirements.txt
- Setup environment variables:
$ cp .env.example .env
- Run migrations:
$ python manage.py migrate
- Start the development server:
$ python manage.py runserver
Access your application at http://localhost:8081
Docker Installation
Use Docker for a consistent development environment across all platforms.
Development Mode
$ cp .env.example .env
$ docker compose --profile dev up --build
Production Mode
$ docker compose --profile prod up -d
$ docker compose --profile prod exec web-prod python manage.py migrate
Project Structure
Understanding the template organization:
- config/ - Django project configuration with split settings
- core/ - Main application containing views and URLs
- templates/ - HTML templates with vanilla CSS
- static/ - Static files (CSS, JS, images)
- requirements.txt - Python dependencies with fixed versions
Environment Configuration
The template uses separate settings for development and production:
Development Settings
Located in config/settings/dev.py
- DEBUG mode enabled
- SQLite database
- Relaxed security settings
Production Settings
Located in config/settings/prod.py
- DEBUG mode disabled
- PostgreSQL database
- Enhanced security (HTTPS, secure cookies, HSTS)
Common Commands
# Create superuser
$ python manage.py createsuperuser
# Collect static files
$ python manage.py collectstatic
# Run tests
$ python manage.py test
# Access Django shell
$ python manage.py shell
Need Help?
If you encounter any issues or have questions, check the README.md file or visit the Contact page.