Lumi - local-first, collaborative knowledge repo

Download

Get the app from landing page

💯 Introduction

Lumi is a local-first personal knowledge management system that works seamlessly even when offline. It supports real-time collaboration, Markdown editing, and block-level references, providing a Notion-like flexible page structure. Lumi enables individuals and teams to efficiently organize and manage knowledge, regardless of network connectivity.

🌟 Features

• Document & Wiki knowledge base
• 📔 Multi-space management
• ⚽ Rich text blocks
  • 🌿 Text block
  • 🎅 Code block
  • ✨ Database block
    • Table view
    • Kanban view
  • 🎈 Multi-column layout block
  • 🎙️ Multi-level heading block
  • 🏮 Embedded web page block
  • 💎 Image & video block
  • 🛍️ Quote block
  • 🎹 Table block
  • List block
    • 💛 Unordered list
    • 🧡 Ordered list
    • 🩵 Task list
    • ❤️ Foldable list
• 🏀 Inline blocks
  • 👀 @Mention
  • 😀 Emoji
• 🎱 Extensive keyboard shortcuts
• 🏓 Text selection comments
• 🏐 Tag management
• 🎾 Markdown

🚀 Development Guide

Projects structure

• apps/client electron wrapper for the app.
• apps/server-pouchdb pouchdb server to sync between devices
• apps/server-yjs yjs server to implement collaboration
• apps/web core app front-end entry
• packages/collection collection component package
• packages/editor core editor package based on prosemirror

Develop

• For local mode

pnpm i
cd apps/web
pnpm run dev

cd apps/client
pnpm run dev

• For sync web mode - not ready for production

pnpm i
cd apps/web
pnpm run dev

cd apps/server-api
pnpm run dev

cd apps/server-pouchdb
pnpm run dev

cd apps/server-yjs
pnpm run start

License

Lumi is licensed under the MIT License.