Quickstart

Get OpenFinance up and running on your local machine in under 5 minutes.

Prerequisites

Node.js 20+ (download)
Yarn 4.0.0 (included via corepack)
OpenRouter API key for AI features (get one)

Setup

Clone the repository

git clone https://github.com/yagudaev/openfinance.git
cd openfinance

Enable Yarn via Corepack

corepack enable
corepack prepare yarn@4.0.0 --activate

Install dependencies

yarn install

Set up environment variables

Create a .env file in the project root:

.env

# Database (SQLite, stored locally)
DATABASE_URL="file:./prisma/data/openfinance.db"

# Authentication
BETTER_AUTH_SECRET="generate-a-random-secret-here"
BETTER_AUTH_URL="http://localhost:3000"

# AI (required for statement processing and chat)
OPENROUTER_API_KEY="sk-or-..."

# Optional: Google OAuth
# GOOGLE_CLIENT_ID="..."
# GOOGLE_CLIENT_SECRET="..."

Generate a secret for BETTER_AUTH_SECRET:

openssl rand -base64 32

Initialize the database

yarn db:generate
yarn db:push

This creates the SQLite database at prisma/data/openfinance.db and sets up all tables.

Start the dev server

yarn dev

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

First Steps

Once the app is running:

Create an account — sign up with your email and password on the login page
Configure settings — go to Settings to set your fiscal year, timezone, and AI model
Upload a bank statement — navigate to Statements and upload a PDF bank statement
Wait for processing — the AI will extract transactions and verify balances automatically
Explore your data — view transactions, check the dashboard, or chat with the AI advisor

Available Commands

Command	Description
`yarn dev`	Start the dev server with Turbopack
`yarn build`	Create a production build
`yarn lint`	Run ESLint
`yarn db:push`	Push Prisma schema changes to the database
`yarn db:studio`	Open Prisma Studio (database browser)
`yarn db:generate`	Regenerate the Prisma client
`yarn db:migrate`	Run database migrations
`yarn test`	Run Playwright end-to-end tests

Get Started

Features

Quickstart

Quickstart

Prerequisites

Setup

First Steps

Available Commands

Next Steps

Bank Statements

Self-Hosting

​Quickstart

​Prerequisites

​Setup

​First Steps

​Available Commands

​Next Steps

Bank Statements

Self-Hosting

Quickstart

Prerequisites

Setup

First Steps

Available Commands

Next Steps