Documentation | Zap Studio

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:

Vite+ (vp) — viteplus.dev
Node.js (v18 or later) — nodejs.org
Rust — rust-lang.org
pnpm — pnpm.io

Optional: Diesel CLI

For database migrations, optionally install Diesel CLI:

cargo install diesel_cli

Installation

1. Clone the Repository

git clone https://github.com/zap-studio/local.ts.git my-app
cd my-app

2. Install Dependencies

vp install

This installs the JavaScript dependencies defined by the repository's lockfile.

3. Run in Development Mode

vp exec tauri dev

This starts the Vite+ powered frontend workflow 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:

vp exec tauri build

The 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.

Common Commands

Local.ts now uses direct vp commands for most day-to-day workflows.

Command	Description
`vp install`	Install project dependencies
`vp dev`	Start the frontend dev workflow
`vp exec tauri dev`	Start the full app with hot reload
`vp build`	Build frontend assets
`vp exec tauri build`	Build the native app for production
`vp check`	Run type-aware checks
`vp check --fix`	Apply automatic fixes from the checker
`vp test`	Run tests once
`vp test watch`	Re-run tests in watch mode
`vp test run --coverage`	Generate a coverage report
`vp test && vp check && vp build`	Run the full validation flow
`vp exec tsr generate`	Regenerate the TanStack Router route tree manually

Tip

Before committing or releasing, run vp test && vp check && vp build to cover the same test, check, and frontend build steps used by the template's regular workflow.

Edit on GitHub

Last updated on

Getting Started