sankalp
4764865ec2
- New Features - Added CI pipeline that runs on push and pull‑request to main and develop, including PostgreSQL service for integration tests. - Enhancements - Integrated linting (ruff), formatting check, migration validation, and security scanning with Django’s --deploy flag. - Bug Fixes - (none)
.
A Django project folder structure is generated with djinitx/djinit/dj.
Features
- Modern project structure with environment-specific settings
- Pre-configured REST API with JWT authentication
- Essential dependencies and utilities
- Production-ready configuration
Setup
Using Just (Recommended)
-
Set environment variables in
.envfile -
Run setup (installs dependencies, runs migrations, creates superuser):
just setup -
Start development server:
just dev
Traditional Method
-
Install dependencies:
pip install -r requirements.txt -
Set environment variables in
.envfile -
Run migrations:
python manage.py migrate -
Create superuser:
python manage.py createsuperuser -
Start development server:
python manage.py runserver
Available Commands
Run just to see all available commands, including:
just dev- Run development serverjust migrate- Run migrationsjust makemigrations- Create migrationsjust createsuperuser- Create superuserjust test- Run testsjust lint- Lint codejust format- Format codejust shell- Django shelljust clean- Clean cache filesjust install <package>- Install packagejust remove <package>- Remove packagejust server- Run production serverjust ci- Run all linting and checksjust test-coverage- Run tests with coverage
Project Structure
./
├── apps/
│ ├── admin/
│ │ └── __init__.py
│ ├── api/
│ │ ├── __init__.py
│ │ ├── urls.py
│ │ └── v1/
│ │ ├── __init__.py
│ │ └── urls.py
│ ├── models/
│ │ └── __init__.py
│ ├── serializers/
│ │ └── __init__.py
│ ├── tests/
│ │ └── __init__.py
│ ├── urls/
│ │ └── __init__.py
│ └── views/
│ └── __init__.py
├── core/
│ ├── asgi.py
│ ├── __init__.py
│ ├── settings/
│ │ ├── base.py
│ │ ├── development.py
│ │ ├── __init__.py
│ │ └── production.py
│ ├── urls.py
│ └── wsgi.py
├── manage.py
├── requirements.txt
├── pyproject.toml
├── uv.lock
├── .env.sample
├── justfile
├── Procfile
├── runtime.txt
└── README.md
API Documentation
When running in development mode, API documentation is available at:
- Swagger UI: http://localhost:8000/docs/
- Schema: http://localhost:8000/schema/