Grim Desktop Monorepo

• English | 한국어

Manage croquis reference assets in a single library with virtual folders, tags, records, and sessions. Use the Croquis window and capture flow to save study results without the old project/graph workflow.

Current direction: a single-library croquis app centered on assets, tags, virtual folders, records, and sessions. See docs/croquis-library-refactor.md.

Recommended Toolchain

• Node.js 20.x · Matches the versions in .nvmrc/.node-version; run nvm use (or your asdf equivalent) to align before installing dependencies.
• pnpm 10.13.1 · Workspace package manager pinned via the root packageManager field.
• Tauri CLI ^2.7.1 & Rust Toolchain · Required to build and run the desktop bundle and execute Rust commands.

Project Highlights

• Cross-platform desktop: Tauri + Rust deliver a lightweight, secure runtime.
• Croquis-first workflow: The main app is now built around a single library, not multiple projects.
• React 19 UI: Built with React, TypeScript, and design-token-driven CSS.
• App-local architecture: Frontend pages/features/entities/shared structure now lives directly inside apps/desktop/src.

Repository Overview

apps/desktop/        # Tauri front end and Rust backend
scripts/             # Translation and other automation scripts
docs/                # Project documentation and refactor notes

Quick Start

1. Install dependencies

   pnpm install

2. Start the desktop dev server

   pnpm dev

   Internally runs pnpm --filter @grim/desktop dev to launch the Tauri development server.

3. Create a production build

   pnpm --filter @grim/desktop build

4. Generate a Tauri bundle

   pnpm --filter @grim/desktop tauri build

Root Script Reference

Command	Description
pnpm dev	Launches the desktop development server (proxies to @grim/desktop dev).
pnpm dev:local-db	Launches dev mode with DB/storage under the repo-local library/ folder.
pnpm ui:demo	Opens the standalone library demo page entry.
pnpm build:front	Produces a static React/Vite build for the desktop front end.
pnpm build	Runs tauri build to bundle the full desktop application.
pnpm tauri	Passthrough helper for arbitrary tauri CLI commands.
pnpm lint:ts	Executes ESLint with auto-fix for TypeScript sources.
pnpm lint:rs	Runs cargo clippy (all targets) against the Rust backend.
pnpm lint	Runs both TypeScript and Rust lint suites.
pnpm lint:fix	Re-runs TS lint with auto-fix and Rust lint with the --fix flag.
pnpm lint:check	Executes ESLint without auto-fix to surface issues quickly.
pnpm format	Checks formatting via Prettier and cargo fmt --check.
pnpm format:write	Applies formatting with Prettier and cargo fmt.
pnpm translate	Regenerates locale JSON from scripts/translator.mjs.

pnpm dev:local-db defaults to ./library; set GRIM_LIBRARY_DIR=/absolute/path to use a different local development library.

Quality Checklist

Goal	Command
Enforce ESLint rules	pnpm lint:check
Apply workspace formatting	pnpm format:write
Rust formatting & linting	cargo fmt --all & cargo clippy --all-targets -- -D warnings (run from apps/desktop/src-tauri)

Development Tips

• Follow the feature-first folder layout within apps/desktop/src/features when shipping new UI flows.
• Keep reusable code inside apps/desktop/src/shared unless there is a strong reason to split it further.
• Prefer app-local hooks, utilities, and types over recreating another shared package layer.
• Update scripts/translations.xlsx and run pnpm translate whenever you touch user-facing copy.

Tech Stack

• Front end: React 19, TypeScript, token-driven CSS
• Desktop shell: Tauri, Rust, SQLx
• Localisation: i18next with an automated translation pipeline (scripts/translator.mjs)

Contributing

See CONTRIBUTING.md for commit conventions and contribution workflow.

License

This project is licensed under the terms of LICENSE.