From 27e371c7fe3045beae256c50f63e51b78c30ec32 Mon Sep 17 00:00:00 2001 From: lucaronin Date: Sun, 12 Apr 2026 10:40:50 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20restore=20README=20content=20lost=20dur?= =?UTF-8?q?ing=20Laputa=E2=86=92Tolaria=20rename?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) diff --git a/README.md b/README.md index 78d3893a..5ad96d94 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,91 @@ Personal knowledge and life management desktop app built with Tauri v2 + React + TypeScript + BlockNote. ## Documentation + +- 📐 [ARCHITECTURE.md](docs/ARCHITECTURE.md) — System design, tech stack, data flow +- 🧩 [ABSTRACTIONS.md](docs/ABSTRACTIONS.md) — Core abstractions and models +- 🚀 [GETTING-STARTED.md](docs/GETTING-STARTED.md) — How to navigate the codebase +- 🎨 [THEMING.md](docs/THEMING.md) — Theme system and customization + +## Quick Start + +### Prerequisites + +- Node.js 20+ +- pnpm 8+ +- Rust (latest stable) +- macOS (for development) + +### Setup + +```bash +# 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 + +```bash +# Frontend tests +pnpm test + +# Backend tests +cargo test + +# Coverage +pnpm test:coverage + +# E2E tests +pnpm test:e2e +``` + +### Code Quality + +```bash +# 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](AGENTS.md) for coding guidelines and workflow. [CLAUDE.md](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](.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](.github/HOOKS.md) for details. + +## License + +Private repository — not licensed for public use.