Build from source
Teldrive
Installation

Build from source

Build and test Teldrive from the repository.

Requirements

  • Go 1.26
  • Bun
  • Just
  • Git
  • PostgreSQL to run the server
  • Podman for integration/E2E tests

Build

git clone https://github.com/tgdrive/teldrive.git
cd teldrive
just install-tools
just build
./bin/teldrive version

just build generates the UI API client, builds the Vite/React UI, and embeds it into the Go binary.

Development

just dev

The root justfile loads .env. Do not commit production secrets.

Validate changes

just check

just check runs generation, linting, builds, tests, and coverage checks.

For focused checks, use just test-unit or just ui-check instead.

Generated code

TypeSpec under typespec/ owns the HTTP contract. After API changes:

just generate-api
just generate-ui

or:

just generate

After SQL/query changes:

just generate-db

Use repository targets instead of editing generated OpenAPI/API/SQLC output directly.

Container image

just image