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 app will be available at http://localhost:5173.

TIP

The UI dev server proxies API requests to http://localhost:3000. Both servers start concurrently with npm run dev.

Docker Quick Start

docker compose up -d

This starts the app with Traefik reverse proxy and automatic TLS. The app will be available at the domain configured in your docker-compose.yml and Traefik config.

What's Next?

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