Notemate (Document Editor)

A collaborative, feature-rich document editor inspired by Notion, designed to provide a seamless, real-time editing experience with infinite nested documents.

---

Key Features

• Real-Time Database – Instant updates across multiple users with collaborative editing.
• Notion-Style Editor – Intuitive, block-based editing interface.
• Light & Dark Mode – Switchable themes for a comfortable user experience.
• Infinite Nested Documents – Create documents with unlimited depth and hierarchy.
• Trash Can & Soft Delete – Delete files without losing them permanently, with easy recovery.
• Authentication – Secure user sessions powered by Clerk.
• File Management
  • Upload files
  • Delete files
  • Replace files
  • Recover deleted files
• Document Customization
  • Add icons to each document (changes reflected in real-time)
  • Add cover images for each document
• Sidebar Features
  • Expandable sidebar
  • Fully collapsible sidebar
• Mobile-First Design – Fully responsive layout for all devices.
• Public Note Publishing – Share your notes on the web.
• Landing Page – SaaS-like polished first impression for your app.

---

Tech Stack

• Frontend: React, Tailwind CSS (or your preferred UI framework)
• Backend: Node.js, Convex (for real-time sync)
• Authentication: Clerk
• Storage & File Handling: EdgeStore – for uploads, replacements, soft deletes, and file recovery

---

Getting Started

Prerequisites

• Node.js >= 18.x
• Yarn
• Clerk account for authentication setup
• Convex account for real-time backend
• EdgeStore account for file management

Installation

git clone https://github.com/MDub3y/Note_on.git
cd notemate
yarn install

Environment Variables

Create a .env file (or copy from .env.example) with the following variables:

# Deployment used by `npx convex dev`
CONVEX_DEPLOYMENT=

# Convex real-time backend
NEXT_PUBLIC_CONVEX_URL=

# Clerk authentication
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=

# EdgeStore for file uploads and management
EDGE_STORE_ACCESS_KEY=
EDGE_STORE_SECRET_KEY=

Running Locally

yarn dev

Visit http://localhost:3000 to view the app in your browser.

Future Improvements

• Enhanced offline support with local caching

• Rich text formatting and block embedding

• Version history and collaborative comments

• Advanced permissions and sharing controls