Skip to content
PentiumRabbitPublic

About

A local-first Notion alternative with block editor, database views, and formula engine.

Topics

Resources

Code of conduct

Contributing

Stars

2 stars

Watchers

0 watching

Forks

Repository files navigation

noteyard

A local-first Notion alternative — block editor, database views, formula engine, all running on your machine.

中文 · GitHub: PentiumRabbit/noteyard · Gitee mirror (China): PentiumRabbit/noteyard

CI Release License Go


Note

This project is entirely generated and maintained by AI. Pull Requests are not accepted. If you find a bug or have a suggestion, please open an Issue.


Features

  • Block Editor — Powered by BlockNote; supports paragraphs, headings, lists, code blocks, quotes, and more
  • Database Multi-View — Switch between Table, Kanban, Gallery, Calendar, Timeline, and List views on the same database
  • Rich Field Types — Text, number, select, multi-select, date, relation, formula, phone, people, status, and more
  • Formula Engine — Built-in recursive-descent formula engine with arithmetic, comparison operators, string functions, and cross-field references
  • Local SQLite Storage — Data lives at ~/.local/share/noteyard/noteyard.db; fully offline, fully private
  • Tauri Desktop App — Native app for macOS, Windows, and Linux; zero external dependencies

Installation

Homebrew (macOS)

brew install --cask PentiumRabbit/tap/noteyard

Desktop App

Download the installer for your platform from the Releases page:

Platform Format
macOS .dmg
Windows .exe (installer)
Linux (deb) .deb
Linux (generic) .AppImage

Install and run — data is stored locally with no additional setup required.

Build from Source

Prerequisites: Go 1.21+, Node.js 18+

git clone https://github.com/PentiumRabbit/noteyard.git
cd noteyard

# Start dev servers (backend :8080, frontend :5173)
make dev

# Production build → bin/noteyard (serves frontend + API on :8080)
make build
./bin/noteyard

Tech Stack

Layer Technology
Frontend React 18 + TypeScript + Vite + BlockNote
Backend Go + chi router
Database SQLite (WAL mode, foreign keys enabled)
Desktop Tauri 2

Contributing

See CONTRIBUTING.md for local development setup, branching strategy, and commit conventions.


License

This project is licensed under the MIT License.

About

A local-first Notion alternative with block editor, database views, and formula engine.

Topics

Resources

Code of conduct

Contributing

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages