Ideal Notes

Ideal Notes aims to be the best-of-all worlds note taking app.

Project Goals

• Full open source with exception of project website
• Self hostable / SaaS
• WikiLink based text editor and referencing
• Block based structure - Roam / Logseq like
• SQL based data queries
• First class TODO management
• LLM integration for notes synthesis and discovery
• Fast, light-weight feel to UI and queries / navigation
• Available anywhere and offline as a web app / PWA / app store app
• CRDT based multiplayer sync
• Constant sync of local and remote files
• File attachment storage, can act as a users primary file system
• Durable remote storage
• User can bring their own storage for privacy and data sovereignty
• Encrypted notes - zero knowledge encryption available for selected blocks
• Can work as local only, local with remote sync, or remote only

Development

Prerequisites

Install pnpm

npm install -g pnpm

Technical Stack and Tooling

Refer to /docs/tech-stack-and-tooling.md