Azen0n/django-boilerplate

Auto-generated Django project with initial Ruff configuration

Django Boilerplate Project

This project includes default auto-generated Django project except for removing comments and minor tweaks (using dotenv variables for secrets).

Usage

1. Clone project

   git clone git@github.com:Azen0n/django-boilerplate.git

2. Set new origin url

   git remote set-url origin new_origin_goes_here

3. Update the project information in pyproject.toml. Ensure you compile any new dependencies if you make changes to them (see New Dependencies)

Installation

1. Install Python 3.12
2. Install uv
3. Create a virtual environment via uv and activate it

   uv venv venv --python=3.12
   source venv/bin/activate

4. Install requirements

   uv pip install -r requirements.txt

5. Rename example.env to .env and set values

   mv example.env .env

New Dependencies

To include new dependencies, add packages to the dependencies list in the pyproject.toml file, then compile them using

uv pip compile pyproject.toml -o requirements.txt

and install

uv pip install -r requirements.txt