/django-starter-kit

Preconfigured boilerplate code, Docker Compose configuration with PostgreSQL integration, and additional helpful configurations for quickly setting up a Django application.

Primary LanguagePythonCreative Commons Zero v1.0 UniversalCC0-1.0

project_name

To get started, rename all instances of project_name in the codebase to the name of your project.

Development Environment Setup

To set up your development environment, use the provided Docker Compose config in the base directory.

  1. Run docker compose up to start the Flask app in a Docker container.

  2. To set up pre-commit hooks, ensure that pre-commit is installed. You can install it using:

    pip install pre-commit

  3. To install the hooks defined in .pre-commit-config.yml, run:

    pre-commit install

    This ensures that code is properly formatted and passes linting checks before commits are made.