Skip to content

ruizhehou/notebook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Notebook - Advanced Note-Taking Application

A powerful note-taking application with rich text editing, folder organization, and AI features.

中文文档

Project Structure

notebook/
├── frontend/          # Next.js frontend application
├── backend/           # Go backend service
└── README.md          # Project documentation

Features

  • 📝 Rich text editor (based on TipTap)
  • 📁 Folder organization
  • 🔍 Note search
  • 📌 Note pinning
  • 🏷️ Tag management
  • 💾 Auto-save
  • 🌙 Beautiful UI design

Quick Start

Frontend

cd frontend
npm install
npm run dev

Visit http://localhost:3000

Backend

cd backend
go run cmd/server/main.go

API service runs on http://localhost:8081

Tech Stack

Frontend

  • Next.js 15
  • React 18
  • TypeScript
  • Tailwind CSS
  • TipTap Editor
  • Zustand state management
  • date-fns

Backend

  • Go 1.22+
  • net/http
  • JSON file storage
  • sync.RWMutex for concurrency control

API Documentation

Note Endpoints

Method Path Description
GET /api/notes Get all notes
GET /api/notes/{id} Get a single note
POST /api/notes Create a note
PUT /api/notes/{id} Update a note
DELETE /api/notes/{id} Delete a note

Folder Endpoints

Method Path Description
GET /api/folders Get all folders
GET /api/folders/{id} Get a single folder
POST /api/folders Create a folder
PUT /api/folders/{id} Update a folder
DELETE /api/folders/{id} Delete a folder

Health Check

Method Path Description
GET /health Service health check

Roadmap

  • User authentication
  • Cloud sync
  • AI-assisted writing
  • Export functionality (PDF, Markdown)
  • Collaborative editing
  • Mobile adaptation

License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors