Quick Start

Get up and running with the Advantch starter kit in minutes

Quick Start

Get your development environment set up and running in minutes.

Prerequisites

Before you begin, ensure you have the following installed:

Clone the Repository

git clone https://github.com/your-org/advantch.git
cd advantch

Backend Setup

1. Install Python dependencies:

cd backend
uv sync --frozen

2. Set up environment variables:

cp .env.example .env
# Edit .env with your configuration

3. Start infrastructure services:

docker compose -f compose.lean.yaml up -d

This starts PostgreSQL, Redis, and Mailpit for local development.

4. Run database migrations:

uv run python manage.py migrate

5. Create a superuser:

uv run python manage.py createsuperuser

6. Start the backend server:

uv run uvicorn config.asgi:application --host 0.0.0.0 --port 8080 --reload

Frontend Setup

1. Install Node dependencies:

cd frontend
pnpm install

2. Start the development server:

pnpm dev

The frontend will be available at http://localhost:3000.

Verify Installation

1. Open http://localhost:3000 in your browser
2. You should see the landing page
3. Navigate to /login to access the authentication flow
4. Log in with your superuser credentials

Project Structure

advantch/
├── backend/          # Django backend
│   ├── apps/         # Django applications
│   ├── config/       # Settings and configuration
│   └── docs/         # Documentation (MDX files)
├── frontend/         # Next.js frontend
│   ├── app/          # App Router pages
│   ├── components/   # React components
│   └── lib/          # Utilities
└── compose.lean.yaml # Infrastructure services

Next Steps

• What is the Starter Kit? - Understand the architecture
• Authentication - Set up authentication
• Local Testing Setup - Configure testing environment