Getting StartedQuick Start

Quick Start

Get ffinn running locally in under five minutes.

Prerequisites

▸Python 3.12+ - backend API
▸Node.js 22+ - frontend
▸PostgreSQL 15+ (or SQLite for local dev)

Clone & Install

git clone https://github.com/bplogan/ffinn.git cd ffinn
Backend
cd python-backend python -m venv .venv source .venv/bin/activate   # Windows: .venv\Scripts\activate pip install -r requirements.txt
Frontend
cd nextjs-frontend npm install

Configure Environment

Copy the example env file and fill in your values:
cp python-backend/.env.example python-backend/.env
Minimum required settings:
DATABASE_URL=postgresql+asyncpg://user:pass@localhost/ffinn JWT_SECRET_KEY=your-secret-key-min-32-chars ENVIRONMENT=development

Run Migrations & Start

In python-backend/
 alembic upgrade head uvicorn app.main:app --reload
In nextjs-frontend/ (separate terminal)
 npm run dev
API is live at http://localhost:8000 - Swagger docs at http://localhost:8000/docs. Frontend is at http://localhost:3000.