- Local first note-taking app built with Tauri.
- Encrypted Sync with nostr
- Encrypted blob storage with blossom
Development:
- Install dependencies:
npm install - Or with
just:just install - Start the desktop app:
npm run tauri:dev - Or with
just:just dev - Build the app bundle:
npm run tauri build -- --bundles app - Or with
just:just bundle - Seed demo notebooks and notes:
npm run seed:db - Lint frontend code:
npm run lint - Type-check frontend code:
npm run typecheck - Run checks:
just check
The seed script resets the local app database by default. To seed a throwaway database instead, pass COMET_DB_PATH=/tmp/comet.db.
This repo includes a project-local justfile for common development commands.
- Install
justwithbrew install justorcargo install just - List available recipes with
just --list - Run commands like
just dev,just lint,just typecheck,just test,just check,just outdated-npm, andjust outdated-crates just outdated-cratesrequirescargo-edit: install it withcargo install cargo-edit
This repo uses Husky + lint-staged for a pre-commit hook on staged files. After npm install, the hook is installed automatically via the prepare script.
On commit, staged files run through:
eslint --fixandprettier --writefor*.tsand*.tsxprettier --writefor*.js,*.mjs,*.cjs,*.json,*.md,*.yml, and*.yaml
Generate and install completions:
mkdir -p ~/.zsh/completions
just --completions zsh > ~/.zsh/completions/_justThen make sure your ~/.zshrc includes:
fpath=(~/.zsh/completions $fpath)
autoload -U compinit
compinitRestart your shell or run source ~/.zshrc.