Make a change

Local development

Set up a development server, run the web app with hot reload, and work with fictional data.

You can develop on macOS or Linux. Windows desktop builds exist, but a Windows development server is not supported.

#Tools

ToolVersion
Bun1.3.12 (the CI pin)
Gofrom native/go.mod
Native build toolsXcode command-line tools on macOS
Optionalripgrep, poppler and pandoc for document tests

#First build

bun install --frozen-lockfile
bun run build:native
bun run typecheck

#Run a development server

  1. Build the web app
    bun run build:web
    
  2. Start the dev supervisor

    Use a new, short data folder and a free port.

    TEAM_AX_DEV_DIR="$HOME/.trina-dev-new" TEAM_AX_DEV_PORT=19761 bun run dev --no-relay
    
  3. Seed fictional data (optional)

    In a second terminal, before you create a team:

    TEAM_AX_DEV_DIR="$HOME/.trina-dev-new" bun run demo:seed --base http://127.0.0.1:19761
    
Warning

The development server uses your OS user's CLI logins and has no production isolation. Use fictional data only. Stop it with Ctrl-C.

#Work on the web app

bun run --cwd web dev     # Vite on port 19140
bun run --cwd web mock    # a mock API server for the UI

The e2e tests run the web app against the mock server in web/test/mock/, so most UI work needs no real server.

#Useful scripts

ScriptWhat it does
bun run demoModel-free demo with a fictional team
bun run devDevelopment supervisor (server, web build, optional relay)
bun run build:nativeBuild the Go helpers
bun run build:webBuild the web app
bun run typecheckType-check server, web and desktop
bun run check:i18nCheck strings in all five languages
bun run check:docsCheck the entry docs and this site's links
bun run docs:buildBuild this documentation site
bun run docs:screenshotsRefresh the docs screenshots from a running server with made-up data

Next: run the tests.

Trina AX is free software under AGPL-3.0-only. Icons: Lucide (ISC). Edit this page