Getting Started

Prerequisites

• Node.js >= 18
• Rust toolchain (for building the native addon)
• npm or compatible package manager

Quick Start

# Clone the repository
git clone https://github.com/dlampatricio/better-reports.git
cd better-reports

# Install dependencies
npm install

# Build the native Typst addon
npm run build:binary

# Start the development server
npm run dev

The backend API will be available at http://localhost:3000 and the UI at http://localhost:5173.

TIP

The UI dev server proxies API requests to http://localhost:3000. Both servers start concurrently with npm run dev. On first access, you'll be redirected to /login � use the credentials configured via env vars or the default admin/password123.

Docker Quick Start

docker compose up -d

See the Docker deployment guide for details.

What's Next?

• Learn how to configure the app
• Create your first template
• Deploy to production with Docker
• Explore the full API reference