Prerequisites
1
Node.js 20 or later
Download from nodejs.org. Tempest uses Node for the React frontend build and npm scripts. Atlas requires Node 20+.
2
Rust (latest stable)
Install the latest stable toolchain via rustup. Tauri compiles the native backend with Rust.
3
Windows: WebView2 Runtime
Windows only. Download from Microsoft Edge WebView2. This is the rendering engine for the Tauri window.
Installation and setup
1
Clone the repository
2
Install dependencies
npm install runs postinstall scripts that automatically stage the Atlas bundle, the chat bridge sidecars, and the cloudflared sidecar. Nothing else to set up.Run in development mode
Start the dev server with live reload:npm run dev runs tauri dev, which:
- Starts the Vite dev server on
http://localhost:1420and launches the Tauri app window - Reloads React components, TypeScript, and styles instantly — HMR shares port 1420
- Recompiles and relaunches the Rust backend whenever
src-tauri/changes
Build for production
Create installers and bundles:- Runs
tauri build: transpiles TypeScript, Vite bundles the React frontend todist/, and the Rust backend is compiled - Bundles platform installers — on Windows: an NSIS installer, an MSI, and a portable
tempest.exe, plus updater artifacts - Copies the NSIS setup executable and the portable executable to
dist-installers/viascripts/collect-artifacts.mjs
Build only the frontend
To bundle the React app without running Tauri:dist/. This is useful for debugging frontend issues or testing the production bundle separately.
Development tips
- Frontend-only development: Run
npm run dev:frontendto start just the Vite dev server on port 1420 without launching the Tauri window - Preview production build: Run
npm run previewto test the bundled frontend in a browser - Tauri CLI: Access Tauri commands directly with
npm run tauri <command>. For example,npm run tauri infoshows your development environment info
Project structure
src/: React TypeScript frontend codesrc-tauri/: Rust backend codesrc-tauri/crates/hephaestus: process isolation layersrc-tauri/crates/dbiso: Docker database branchingpackages/core,packages/crypto,packages/transport: shared wire protocol, crypto, and transport for the mobile companionapps/: mobile companion + relay workerweb/: marketing website (Next.js)dist/: Frontend build output (created byvite build)dist-installers/: Platform-specific installers (created bytauri build)resources/: Assets bundled into the app at runtime
What’s next
Theme System
Customize colors, typography, and radius using the
--tempest-* CSS variable system.Workspaces
Learn how workspaces are created, stored, and switched at runtime.