NOTEDIT

AI-powered collaborative note editor for teams and individuals.
Built with BlockNote, Yjs/Hocuspocus, React, and Express.

English · 简体中文 · 文档 · 反馈

^{Write together, think faster.}

---

Table of contents

• Features
• Quick Start
• Local Development
• Contributing
• License

---

Getting Started

Welcome to NOTEDIT! It is a collaborative note editor focused on fast writing, real-time teamwork, and AI-assisted editing.

The project solves a common workflow pain point: teams want docs + collaboration + export + AI in one place, without switching tools.

Important

Star Us - Your support helps us continue improving!

---

Features

Real-time Collaboration with Yjs + Hocuspocus

Edit the same document together in real time. Presence status and conflict-free synchronization are powered by Yjs + Hocuspocus.

---

AI-powered Writing Assistance

Integrated AI chat and editing flow with streaming output. Great for drafting, rewriting, summarizing, and structured document refinement.

Tip

Pro tip: Combine AI suggestions with collaboration mode for rapid team iteration.

---

Rich Editing + Export + Sharing

Use a modern rich-text editor, upload images, export to Markdown/PDF/DOCX, and generate share links for teammates.

// Example idea: collaboration hook usage
const { editor, status } = useCollaboration({
  docId,
  userName: user?.username,
  userColor: "#1971c2",
});

---

Quick Start

Prerequisites

• Node.js 20+
• pnpm 10+
• MongoDB (local or cloud)

1) Install dependencies

From repository root:

pnpm install

2) Configure environment variables

Create web/server/.env (you can copy from web/server/.env.example) and fill in values:

MONGODB_URI=
PORT=3001
JWT_SECRET=
ALIBABA_CLOUD_API_KEY=
ALIBABA_CLOUD_BASE_URL=
ALIBABA_CLOUD_MODEL_NAME=
CLIENT_ORIGIN=http://localhost:5173

Optional client variable:

VITE_COLLAB_WS_URL=ws://localhost:3001

3) Start backend

cd web/server
pnpm dev

4) Start frontend

cd web/client
pnpm dev

Frontend default: http://localhost:5173
Backend default: http://localhost:3001

---

Local Development

Project structure

web/
├── client/          # React + Vite frontend
├── server/          # Express API + Hocuspocus collaboration server
└── server/uploads/  # uploaded files

Main routes

• Frontend: /login, /wiki, /wiki/:docId
• Backend: /api/auth, /api/documents, /api/uploads, /health
• WebSocket: /, /collaboration, /collaboration/:documentName

Tech stack

Category	Technologies
Frontend	React 19, TypeScript, Vite, Ant Design, BlockNote, i18next
Collaboration	Yjs, Hocuspocus
Backend	Express 5, TypeScript, Mongoose, JWT, Multer
AI	AI SDK + OpenAI-compatible provider (Qwen/Alibaba Cloud)

---

Contributing

Contributions, issues, and feature requests are welcome!

1. Fork the repo
2. Create your feature branch
3. Commit your changes
4. Open a PR

Please keep PRs focused and include clear reproduction steps for bug fixes.

---

License

ISC © NOTEDIT

---

_{If this project helped you, please give it a star.}