getting-started.md

Getting Started

Prerequisites

• Python 3.12+ (check with python --version)
• Docker (for PostgreSQL)
• uv package manager

Initial Setup

1. Install uv (if not already installed)

   curl -LsSf https://astral.sh/uv/install.sh | sh

2. Install dependencies

   uv sync

3. Set up environment variables

   Create .env file in project root:

   SECRET_KEY=your-secret-key-here
   DEBUG=True
   DATABASE_URL=postgres://makerdb:makerdb@localhost:5432/makerdb

   Generate a secret key:

   python -c "from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())"

4. Start PostgreSQL

   docker compose up -d

5. Run migrations

   uv run python backend/manage.py migrate

6. Create superuser (optional, for admin access)

   uv run python backend/manage.py createsuperuser

7. Start development server

   uv run uvicorn makerdb.asgi:application --reload --app-dir backend

   The server will be available at:

   • API: http://localhost:8000/api
   • Admin Panel: http://localhost:8000/cp
   • Health Check: http://localhost:8000/api/health