Getting Started
Set up Local.ts and run your first build.
This guide walks you through setting up Local.ts and running your first build.
Prerequisites
Before you begin, make sure you have the following installed:
- Node.js (v18 or later) — nodejs.org
- Rust — rust-lang.org
- pnpm (recommended) — pnpm.io
- Turbo — turborepo.com
Optional: Diesel CLI
For database migrations, optionally install Diesel CLI:
cargo install diesel_cliInstallation
1. Clone the Repository
git clone https://github.com/zap-studio/local.ts.git my-app
cd my-app2. Install Dependencies
pnpm installThis installs npm packages.
3. Run in Development Mode
turbo tauri -- devThis starts the Vite development server with hot reload and opens your app in a native window. Changes to your React code will update instantly.
Building for Production
Create a production build for your current platform:
turbo tauri -- buildThe output will be in src-tauri/target/release/bundle/ with platform-specific installers.
Customizing Your App
After cloning, update your app's name, version, and branding. See the Project Identity guide for a complete walkthrough.
Available Run Scripts
Local.ts includes several scripts to streamline your development workflow.
| Command | Description |
|---|---|
turbo dev | Start Vite dev server (frontend only) |
turbo tauri -- dev | Start full app with hot reload |
turbo tauri -- build | Build for production |
turbo check | TypeScript type checking |
turbo lint | Run linter |
turbo format | Format code |
turbo test | Run tests |
turbo validate | Run build, check, lint, and test to validate everything passes |
Tip
The validate script is useful before committing or deploying — it ensures your code builds correctly and passes all quality checks in one command.
Last updated on