Skip to content

README.md

Latest commit

 

History

History
78 lines (59 loc) · 2.65 KB

README.md

File metadata and controls

78 lines (59 loc) · 2.65 KB

note.box

A minimal, distraction-free note-taking app. Client-only SPA — no server, no account.

Deploy Release License

Features

  • Rich-text editor powered by TipTap — tables, task lists, highlights
  • Zen monochrome theme with 7 curated font choices
  • Notes stored in your browser via localStorage — nothing leaves your device
  • Responsive layout with collapsible sidebar
  • Keyboard shortcuts for everything
  • 9 languages supported
  • Installable as a PWA

Getting Started

pnpm install
pnpm dev

Open localhost:3000.

Commands

pnpm dev          # Start dev server
pnpm build        # Build for production
pnpm generate     # Generate static site
pnpm test         # Run unit + component tests
pnpm test:e2e     # Run E2E tests (Playwright)
pnpm lint:fix     # Lint and auto-fix
pnpm typecheck    # Type-check

Stack

Contributing

Contributions are welcome! Please open an issue first to discuss what you'd like to change.

Release process

This project uses Changesets for versioning and releases.

  1. Make your changes on a branch and open a PR.
  2. Run pnpm changeset and follow the prompts to describe your changes.
  3. Commit the generated changeset file alongside your code changes.
  4. Once merged to main, the Release workflow opens a "Version Packages" PR that bumps versions and updates the changelog.
  5. Merging that PR triggers a production deploy to Cloudflare Pages and creates a GitHub Release.

License

AGPL-3.0