Backend Setup

This guide walks you through setting up the Maybern Django backend for local development.

All commands in this guide should be run from within the backend/ directory unless otherwise specified.

Set Up PostgreSQL Database

Add PostgreSQL to PATH

Add the PostgreSQL binaries to your shell path:

echo 'export PATH="/opt/homebrew/opt/postgresql@13/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

Set up libpq for psycopg

The libpq library is required for the Python PostgreSQL adapter:

echo 'export PATH="/opt/homebrew/opt/libpq/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

Create database user

Create the maybern user in PostgreSQL:

createuser maybern -d -s -r -P

When prompted for a password, enter maybern.

Create database

Create the maybern database with the new user as owner:

createdb maybern -O maybern

Verify the database setup by running psql -U maybern -d maybern -c '\dt'. You should connect successfully (the table list will be empty until migrations run).

Set Up Python with Pyenv

Configure Pyenv

Add Pyenv to your shell configuration:

echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.zshrc
echo '[[ -d $PYENV_ROOT/bin ]] && export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.zshrc
echo 'eval "$(pyenv init -)"' >> ~/.zshrc
source ~/.zshrc

Install the project Python version

Install the Python version specified in the project’s .python-version file:

pyenv install < .python-version

Set global Python version (optional)

Set this version as your global default:

pyenv global $(cat .python-version)

Set Up uv for Dependency Management

Install uv

Install uv using the standalone installer:

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

Or using Homebrew:

brew install uv

Verify installation

Check that uv is installed correctly:

uv --version

Set Up Virtual Environment

Install dependencies

Create the virtual environment and install all dependencies:

uv sync

This will create a .venv directory and install all dependencies from the lockfile.

Activate the virtual environment

Activate the virtual environment:

source "$(pwd)/.venv/bin/activate"

Consider adding an alias to your .zshrc for quick activation:

alias activate-maybern='cd ~/path/to/maybern/backend && source .venv/bin/activate'

Troubleshooting: uv Python version mismatch

If uv is using the wrong Python version:

Check what Python versions are available:
```
uv python list
```
Verify Pyenv is using the correct version:
```
pyenv which python
```
Pin uv to use the correct Python version:
```
uv python pin "$(pyenv which python)"
```
Remove the existing virtual environment and reinstall:
```
rm -rf .venv
uv sync
```

Set Up Environment Variables

Create the local .env file from the template:

DJANGO_SECRET_KEY=$(python3 -c 'from django.utils.crypto import get_random_string; print(get_random_string(50))') \
  POSTGRES_DB=maybern POSTGRES_USER=maybern POSTGRES_PASSWORD=maybern \
  DJANGO_DATABASE_HOST=localhost \
  envsubst < config/.env.template > config/.env

This is a single command that spans multiple lines. Run it as-is.

Reach out to your onboarding partner to get additional environment variables for third-party services (Stytch, AWS, etc.).

IDE Setup (VS Code / Cursor)

Install the recommended extensions for Python development:

Ruff: Python formatting and linting

Add to your settings.json:

{
  "[python]": {
    "editor.defaultFormatter": "charliermarsh.ruff"
  }
}

For Cursor users, also install Cursor Pyright for type checking:

{
  "cursorpyright.analysis.typeCheckingMode": "recommended"
}

Introduction

Local Setup

Backend Setup

Backend Setup

Set Up PostgreSQL Database

Set Up Python with Pyenv

Set Up uv for Dependency Management

Set Up Virtual Environment

Set Up Environment Variables

IDE Setup (VS Code / Cursor)

Next Steps

Frontend Setup

Running the Stack

Introduction

Local Setup

​Backend Setup

​Set Up PostgreSQL Database

​Set Up Python with Pyenv

​Set Up uv for Dependency Management

​Set Up Virtual Environment

​Set Up Environment Variables

​IDE Setup (VS Code / Cursor)

​Next Steps

Frontend Setup

Running the Stack

Backend Setup

Set Up PostgreSQL Database

Set Up Python with Pyenv

Set Up uv for Dependency Management

Set Up Virtual Environment

Set Up Environment Variables

IDE Setup (VS Code / Cursor)

Next Steps