Prerequisites
Before you begin, ensure you have the following tools installed:Install Rust
Install Bun
Install Tauri CLI
Platform-Specific Dependencies
- macOS
- Linux
- Windows
Install Xcode Command Line Tools:
Clone the Repository
Automated Setup
The quickest way to set up your development environment is using the automated installer with the--dev flag:
Run the dev installer
- Verifies all prerequisites (Rust, Bun, Tauri CLI)
- Checks platform-specific build dependencies
- Installs frontend packages via Bun
- Downloads the TTS sidecar binary
- Verifies the Rust build compiles
Manual Setup
If you’ve already installed dependencies manually or prefer more control:TTS Sidecar Binary
Handhold uses Kokoro for text-to-speech synthesis. Thekoko binary must be built separately and placed in the correct location:
The target triple depends on your platform:
- macOS ARM:
aarch64-apple-darwin - macOS Intel:
x86_64-apple-darwin - Linux:
x86_64-unknown-linux-gnu - Windows:
x86_64-pc-windows-msvc
Verify Installation
Confirm everything is set up correctly:Optional: Container Runtime for Labs
To run interactive labs with service dependencies (Postgres, Redis, etc.), install either Podman or Docker:Container runtimes are only required for labs that spin up services. Narrated lessons work without containers.
Troubleshooting
Rust compilation errors
Ensure you’re using the stable Rust toolchain:Tauri build fails on Linux
Double-check that all system dependencies are installed. The error messages usually indicate which library is missing.Frontend build errors
Clear the Bun cache and reinstall:Next Steps
Architecture
Understand how Handhold is structured
Building
Learn how to build and run the app
Frontend
Explore the React frontend architecture
Backend
Dive into the Rust backend