Pulm Notes

A local-first, offline-capable personal note-taking app.

Available as both a web app and a native desktop app (via Tauri).

Prerequisites

• Node.js 18+ (or bun 1.0+)
• bun package manager
• For desktop app: Rust toolchain (see Tauri prerequisites)

Installation & Setup

1. Install dependencies using bun:

   bun install

2. Web App: Start the development server:

   bun run dev

   Open http://localhost:3000 in your browser

3. Desktop App: Run the Tauri development build:

   bun run tauri:dev

Build for Production

Web App:

bun run build
bun start

Desktop App:

bun run tauri:build

Installers will be created in src-tauri/target/release/bundle/

Technology

• Framework: Next.js 15 (App Router)
• Desktop Shell: Tauri 2.0 (Rust)
• UI Library: React 19
• Styling: Tailwind CSS
• Icons: lucide-react
• Package Manager: bun

Features

• Local-first: All data stays on your device
• Offline-capable: Works without internet
• Private: No cloud, no tracking, no accounts
• Minimalist text editor interface
• Slash command menu (type / to open)
• Support for multiple block types (headings, lists, code, quotes, etc.)
• Keyboard shortcuts for navigation and editing
• Clean, responsive design
• Desktop app: Native performance with Tauri

Migration Notes

• Next.js Migration: See docs/NEXT_MIGRATION_LOG.md
• Tauri Integration: See TAURI_AUDIT_LOG.md for desktop architecture details

Manual Release Process

1. Ensure commits follow Conventional Commits.
2. When ready to release, run:

git tag vX.Y.Z
git push origin vX.Y.Z

3. GitHub Actions will run CI, semantic-release, generate CHANGELOG, update package.json version, create the GitHub Release, attach Tauri artifacts, and generate checksums.