Files
tolaria/README.md
2026-04-18 09:16:06 +02:00

2.3 KiB

CodeScene Hotspot Code Health CodeScene Average Code Health

Tolaria App

Personal knowledge and life management desktop app built with Tauri v2 + React + TypeScript + BlockNote.

Documentation

Quick Start

Prerequisites

  • Node.js 20+
  • pnpm 8+
  • Rust (latest stable)
  • macOS (for development)

Setup

# Install dependencies
pnpm install

# Run dev server
pnpm dev

# Open in browser (mock mode)
open http://localhost:5173

# Or run in Tauri
pnpm tauri dev

Testing

# Frontend tests
pnpm test

# Backend tests
cargo test

# Coverage
pnpm test:coverage

# E2E tests
pnpm test:e2e

Code Quality

# Lint
pnpm lint

# Rust checks
cargo clippy
cargo fmt --check

# CodeScene (via Claude Code)
claude 'Check code health with CodeScene MCP'

Development Workflow

See AGENTS.md for coding guidelines and workflow. CLAUDE.md remains as a compatibility shim for Claude Code.

Key principles:

  • Small, atomic commits
  • Test as you go
  • Visual verification mandatory
  • Documentation updated with code changes

CI/CD

GitHub Actions runs on every push to main:

  • Tests (frontend + Rust)
  • 📊 Coverage (70% threshold)
  • 🎨 Lint & format
  • ⚠️ Documentation check

See .github/SETUP.md for CI/CD configuration.

Git Hooks

Husky installs the git hooks from .husky/ during pnpm install. The repo enforces main-only commits and pushes; see .github/HOOKS.md for details.

License

Tolaria is licensed under the GNU Affero General Public License, version 3 or any later version (AGPL-3.0-or-later).

See LICENSE for the full license text.

Trademarks

The Tolaria name and logo are not licensed under the AGPL.

See trademarks.md for the trademark policy.