Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Leonxlnx/todobar/llms.txt

Use this file to discover all available pages before exploring further.

Todobar is a Tauri v2 + React application. You need Node.js LTS, Rust stable, and the Tauri v2 platform prerequisites before you can run the app locally. The steps below walk you through installing dependencies, starting a development session, and validating the project before opening a pull request.

Requirements

  • Node.js LTS (18 or later recommended)
  • Rust stable — install via rustup
  • Tauri v2 platform prerequisites — WebView2 on Windows, Xcode Command Line Tools on macOS. See the Tauri v2 prerequisites guide for the full list.

Setup

1

Clone the repository

Fork the repository on GitHub and clone your fork locally:
git clone https://github.com/your-username/todobar.git
cd todobar
2

Install dependencies

Install Node.js and Rust dependencies:
npm install
Cargo dependencies for the Tauri backend are fetched automatically the first time you run a Tauri command.
3

Start a development session

Choose how you want to run the app:
npm run dev
npm run dev opens a browser tab at http://127.0.0.1:5173 — useful for fast UI iteration without a native build. npm run tauri:dev compiles the Rust backend and launches the real desktop app with hot reload.
4

Build for production (optional)

npm run tauri:build
This produces platform installers in src-tauri/target/release/bundle/. See Building and releasing Todobar installers for details on the full release flow.

Validation commands

Run these before opening a pull request to catch issues early.
npm run verify
npm run verify checks version consistency across package.json, Cargo.toml, and tauri.conf.json, and validates that documented scripts and workflow expectations are met. npm run test:smoke runs a Playwright browser smoke test against the Vite preview. If Chromium is not installed locally, run npx playwright install chromium once before your first run. npm run test:native performs a no-bundle Tauri release build (tauri build --ci --no-bundle). It validates that the native desktop shell compiles without producing full installers — faster than a complete release build and useful for confirming Rust changes are sound.
On a fresh machine, npm run test:native can take several minutes the first time while Cargo downloads and compiles Tauri dependencies. Subsequent runs are significantly faster.

Build docs developers (and LLMs) love