Skip to content

Installation

Prerequisites

  • Python 3.12+
  • Node.js (for frontend dependencies)
  • Django 5.x

Steps

  1. Clone the repository

    git clone <your-repo-url>
    cd delta
    
  2. Install Python dependencies

    pip install -e .[dev]
    
  3. Install Node.js dependencies

    npm install
    
  4. Copy static assets

    python copy_node_to_static.py
    
  5. Apply migrations

    python manage.py migrate
    
  6. Create a .env file

    SECRET_KEY=your-secret-key
    
  7. Set up pre-commit hooks

    This project uses the pre-commit package to ensure code quality by running both black and pylint before any commit.
    To enable this, run:

    pre-commit install
    

    Now, every time you commit, black and pylint will automatically check your code.

  8. Run the development server

    python manage.py runserver
    
  9. Access the app

    Open http://localhost:8000 in your browser.