About this project
EdgeEver is a modern, open-source notes and knowledge base workspace that revives the beloved Evernote-style three-pane layout while offering an open data architecture and seamless AI Agent integration for complete ownership and smart productivity.
## Why EdgeEver
Many long-time Evernote users simply want a reliable, open, and fast personal knowledge base. Existing mainstream solutions all present tradeoffs:
- **Evernote**: Bloated with commercial ads, cumbersome data export, restricted free tiers, and costly AI/MCP features.
- **Obsidian**: Closed-source core, paid official sync, and heavy for lightweight capture.
- **Memos & Stream Notes**: Social-timeline layouts differ from structured productivity.
- **SiYuan & Block-based PKMs**: Granular block-level architecture adds cognitive overhead and lacks a true zero-cost serverless tier.
**EdgeEver fills this gap**: The entire stack is open source, including sync and self-hosting. It keeps the three-pane layout, stays silky-smooth with 10,000+ notes, and ships native AI agents with zero-cost deployment.
## Features
- **Deploy Your Way**: Run on Cloudflare's free serverless platform or with Docker on a VPS, NAS, or home server. Personal deployment can hold roughly 150,000 short notes and 50,000 images on Cloudflare; Docker scales on demand.
- **Open Data, No Vendor Lock-in**: Built on standard SQLite with complete REST API, MCP, and CLI access.
- **Lossless ZIP Backup & Portability**: Export your complete library as a clean archive containing Markdown, Front Matter, nested folders, relative attachment links, and version histories.
- **Native AI Agent Synergy**: Deep integration with Model Context Protocol (MCP) allows AI Agents like Claude Code, Codex, Antigravity, and WorkBuddy to read, organize, and summarize notes, or sync with Notion and Feishu Bitable.
- **Bring Your Own AI Models**: Connect OpenAI, Anthropic, or Gemini-compatible services for smart summarization, key point extraction, proofreading, translation, and text continuation.
- **Rich Plugin API**: Extend EdgeEver with a Plugin API.
- **Unlimited Multi-Device Sync**: No commercial device caps or paywalls. Sync across PC, tablet, and mobile via web, PWA, or browser.
- **Classic Three-Pane Layout & Focus Mode**: Notebook trees, note lists, and an expansive editor with a desktop focus mode.
- **Light, Lasting Desktop Performance**: Switching notes does not keep old images and documents in memory.
- **Unlimited Nested Notebooks**: Organize knowledge with arbitrary folder depth.
- **One-Click Rich Copy for Newsletters & Blogs**: Convert notes into formatted rich text with inline CSS for Substack, Medium, WordPress, or newsletter editors.
- **Seamless Dual-View Editor**: Switch between rich text editing and Markdown source code on desktop.
- **Convenient Single-Note Export**: Export as Markdown, HTML, or PDF.
- **Native Mermaid Diagram Rendering**: Render flowcharts, sequence diagrams, and mind maps directly in notes.
- **Visual Diagram Notes**: Sketch mind maps, flowcharts, and architecture diagrams directly in notes with smart auto-layout and vector export.
- **Revision History**: Inspect and restore previous iterations of notes.
- **Public Note Sharing**: Share notes publicly with optional auto-generated access passwords.
- **WeChat Article Clipping on Mobile**: Extract content from WeChat Official Account articles.
- **Smart Local Image Compression**: Client-side WebP compression reduces file sizes by 50%-90%.
- **Universal File Attachments**: Attach and preview PDFs, Office documents, zip files, audio, and video; chunked uploads support files up to 1 GiB.
- **Batch Operations & Flexible Sorting**: Merge or relocate multiple notes with drag-and-drop notebook reordering.
- **Offline Drafts & Queueing**: Draft and edit offline; changes sync once reconnected.
- **Brute-Force Login Protection**: Server-side account- and IP-based failed-login throttling.
- **Multi-Tenant Account Isolation**: Host multiple user accounts on a single instance with strictly partitioned spaces.
- **Everywhere You Need It**: Available on Web, Android, macOS, Windows, Linux, and iOS; Web Clipper supports Chrome, Edge, and Firefox.
## Deployment
### Option A: Deploy with an AI Agent (Recommended)
Copy a prompt into an AI Agent (such as Codex, Claude, Cursor, WorkBuddy, Antigravity, etc.) to deploy EdgeEver entirely through GitHub and Cloudflare. The agent forks the repository, creates D1 and R2 resources, creates a Worker, sets the admin password, and enables automatic updates.
### Option B: Manual Online Deployment
Complete setup in 6 web steps: fork the repository, create Cloudflare resources, import and configure the project, choose an administrator password, build and verify, and enable automatic updates.
### Option C: Docker on a VPS or NAS
Use the GitHub-hosted installer:
```sh
curl -fsSL https://edgeever.org/install.sh | bash
```
The command pulls the latest image, generates an administrator password, starts EdgeEver with Docker Compose, and schedules daily automatic updates.
## Multi-Account Login
A single instance supports multi-account login. The instance administrator can create, disable, or reset member accounts. Each member gets a fully isolated personal workspace.
## Browser Web Clipper
The Web Clipper is officially published for Chrome, Microsoft Edge, and Firefox.
## Community and Feedback
- Bugs, feature requests, and deployment issues: GitHub Issues
- Code contributions: read the Contribution Guide
- Join the EdgeEver Telegram group for discussions on AI Agent applications and automation workflows.
## Plugins and Themes
Web and desktop apps support functional plugins and custom themes, installable from the official marketplace, GitHub, or a Manifest URL. Developers can extend capabilities using `@edgeever/plugin-api`.
## Tech Stack
- Bun workspace monorepo with Web, API, official site, and shared type package.
- Frontend: Vite, React, React Router, TanStack Query, Tailwind CSS, shadcn/ui, and Radix UI.
- Editor: TipTap / ProseMirror with Markdown support; PWA uses vite-plugin-pwa, Workbox, and Dexie.
- Android app: Expo + React Native with SQLite local storage and incremental sync.
- iOS app: Native SwiftUI (iOS 17+), with a packaged TipTap EditorBundle, GRDB local mirror/outbox.
- Native desktop app: Electron + Rust sidecar for high-performance local data services.
- Web clipper: Manifest V3, Mozilla Readability, and Turndown.
- Backend: Hono/Zod business application with REST API and Remote MCP; Cloudflare uses Workers/D1/R2, while Docker uses Bun/SQLite/local files or S3.
- Official site: Astro static site deployable to Cloudflare Pages.
## Quick Start
```sh
bun install
bun run dev
```
Local development signs in automatically; fresh databases use `owner` / `edgeever-local-dev`.
## Content Formats
EdgeEver stores note content in three forms: `content_json` (TipTap/ProseMirror document), `content_markdown` (API, Agent, import, and export format), and `content_text` (Search, summary, and indexing text).
## MCP
Create an API token in Profile -> MCP settings and give it to your AI Agent. The Agent can securely manage your knowledge base within your account permissions, supporting text notes and diagram notes with full CRUD capabilities, plus connections to Notion databases and Feishu Bitable.
## Image Compression
Image compression happens in the Web client before upload. PNG, JPEG, WebP, and AVIF files are converted to WebP when beneficial, with the longest edge limited to 2560px.
## Advanced Object Storage
The instance owner can configure S3-compatible object storage under Settings -> Advanced -> OSS object storage.
## Migration
Migration guides are available for Evernote, flomo, Memos, and Notion.
## Docker Deployment
Docker runs the same frontend, API routes, services, authentication, MCP implementation, and migrations as Cloudflare. The container uses SQLite with local files or S3-compatible attachment storage and supports `amd64` and `arm64`.
## Sync Timing
Web, PWA, and desktop upload memo edits after 30 seconds of inactivity and check for remote changes every 5 minutes while visible; focus and manual refresh remain immediate.
## Acknowledgements
EdgeEver's note-taking product design was informed by publicly available product experiences of mature note-taking tools such as Evernote. The related features were independently designed and implemented by EdgeEver.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.