Skip to content

Navigation Menu

Sign in
Sign up

Repository files navigation

Easy Starter Django Backend

A production-capable Django backend with admin, API foundations, PostgreSQL, Docker, tests, and secure environment configuration.

Use this template License: MIT Status: foundation Django Python PostgreSQL Docker uv

فارسی · Documentation · Report an issue

"What do we build for, if not to lessen each other’s hardship?"

Important

This repository is currently in the foundation stage. Do not treat it as production-ready until the first stable release.

What it solves

Provides a consistent backend foundation so projects start with secure settings, clear app boundaries, repeatable local development, and production checks.

Use this template for

  • REST APIs and business backends
  • Django Admin-based operations
  • Backends for Next.js, mobile apps, bots, and extensions
  • Data-heavy and workflow-driven products

Not intended for: A microservice fleet or a prebuilt domain model for every business.

Baseline

  • Environment-specific settings and validation
  • Custom user model and admin foundations
  • PostgreSQL, migrations, health checks, and structured logging
  • Docker-based local and production workflows
  • Tests, linting, type checks, CI, and deployment checklist

Detailed architecture, conventions, deployment profiles, and extension guides belong in docs/. Feature work starts from specs/, and agent rules live in AGENTS.md.

Quick start

  1. Click Use this template, create new repo in your own account, and clone it on your system.

  2. Set the project name, package metadata, and environment values.

  3. Start the project:

    cp .env.example .env
    make setup
    make dev
    make check
  4. Write the first feature specification under specs/.

  5. Implement the feature and keep make check green.

Working agreement

  • Read AGENTS.md and the relevant specification before changing code.
  • Reuse existing patterns before adding abstractions or dependencies.
  • Never commit credentials or production data.
  • Run the repository quality checks before opening a pull request.
  • Record architecture-changing decisions in docs/decisions/.

Documentation

Start with docs/getting-started.md. Broader AI-first development guidance is maintained in Easy Starter Docs.

Contributing and support

See CONTRIBUTING.md for contribution rules and SUPPORT.md for help. Security issues must follow SECURITY.md.

License

Released under the MIT License.

About

Production-capable Django backend template with admin, API foundations, PostgreSQL, Docker, testing, and secure environment configuration

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

AltStyle によって変換されたページ (->オリジナル) /