BUILD.md

Build Guide

This guide covers how to build Llumen from source for development or production.

Prerequisites

Tool	Version	Notes
Rust	≥1.89	MSRV is 1.89
Node.js	≥20	For frontend
pnpm	≥9	Package manager
sqlite3	-	For local development
sea-orm-cli	≤1	Database migration
typeshare	≥1.13	API codegen

Development Setup

1. Install Frontend Dependencies

cd frontend
pnpm install

2. Run Backend with Dev Features

Use cargo xtask from the backend directory:

cd backend
cargo xtask run

This runs the backend on http://127.0.0.1:8001 with development features enabled.

3. Build and Run Together

cd backend
cargo xtask run-with-build

This builds the frontend first, then runs the backend.

Production Build

Build Frontend Only

cd frontend
pnpm build

Output is in frontend/build.

Build Full Application

cd backend
cargo xtask build

This builds the frontend and then compiles the Rust backend in release mode.

The final binary is located at backend/target/release/backend.

Database Migrations

Run migrations from the backend directory:

cd backend
cargo xtask fresh     # Drop all tables and recreate
cargo xtask refresh  # Refresh database

Code Generation

Generate TypeScript Types

cd backend
cargo xtask gen-ts

Generates TypeScript types from Rust structs using typeshare.

Generate SeaORM Entities

cd backend
cargo xtask gen-entity

Requires sea-orm-cli:

cargo install sea-orm-cli

Generate License File

cd backend
cargo xtask gen-license

Generates THIRDPARTY.toml for dependency licenses.

Testing

Backend Tests

cd backend
cargo test
cargo test --release  # Faster tests

Frontend Tests

cd frontend
pnpm test       # Run tests
pnpm check      # TypeScript check
pnpm lint       # Format check

Code Formatting

Backend

cargo +nightly fmt

Frontend

cd frontend
pnpm format