ShareNote - Real-time Collaborative Note System

中文 | English

📝 Project Overview

ShareNote is a feature-rich real-time collaborative note system that supports multi-user collaborative editing, permission management, real-time notifications, and desktop applications. The system adopts a front-end and back-end separation architecture, providing both web and desktop client usage options.

✨ Core Features

📚 Note Management

• Dual Window Interface: Note editing window + independent clock window
• Real-time Collaboration: Multiple users editing simultaneously with real-time content synchronization
• Permission Control: Three-tier management (creator, write permission, read permission)
• Sharing Mechanism: Generate share codes to invite users to join collaboration

🎨 Content Editing

• Markdown Support: Complete Markdown syntax rendering
• Content References: Support for referencing other content fragments with quick navigation
• Change Tracking: Record all content modification history with detailed diff comparison
• Scroll Loading: Scroll down to load note list, scroll up to load content details
• Smart Editing: Support shortcuts, auto-resize, drag & drop upload and other convenient features

📋 Template Management

• Template Creation: Support creating personal content templates (max 10 per user)
• Template Editing: Online editing of template content with Markdown syntax support
• Template Preview: Click template names for instant preview of rendered Markdown content
• Template Insertion: One-click insertion of template content into current editing area
• Template Management: Support deleting and modifying existing templates

📜 History Tracking

• Change Records: Complete recording of each content modification history
• Version Comparison: Visual display of differences between old and new content
• Author Identification: Show author and time information for each modification
• History Browsing: Support browsing and viewing any historical version content

🔔 Real-time Notifications

• Status Reminders: New content (blue), modified content (green) status indicators
• WebSocket: Real-time push to all online related users
• Message Popup: Floating message notifications displayed in the top-right corner
• Message Navigation: Click messages to directly jump to corresponding note content
• Message Categorization: Support different message types like create, modify, reference
• Message Management: Support clearing message history to avoid message accumulation
• Desktop Alerts: System notifications combined with desktop application

🕰️ Smart Clock

• Auto Switch: Automatically display clock when note window loses focus
• Status Linkage: Clock color syncs with reminder status
• Font Adjustment: Support custom clock font size

📁 File Management

• File Upload: Support for uploading images, documents and other files
• Online Preview: Online preview function for image files
• File Download: Secure file download mechanism

🛠️ Technical Architecture

Frontend Technology Stack

• Web: Native JavaScript + HTML5 + CSS3
• Desktop: Python + PySide6 + WebEngine
• UI Design: Responsive design, supports multiple screen sizes

Core Features

• Real-time Sync: WebSocket persistent connection for millisecond-level synchronization
• Permission Management: Fine-grained permission control system
• Offline Support: Desktop client supports offline viewing
• Cross-platform: Supports Windows, macOS, Linux

Client Usage

pip install pyside6
python main.py

📱 Feature Screenshots

User Authentication

Note Management

Permission Management

Note Content

MarkDown Content Creation

Content Creation and Editing Interface

Drag & Drop File Upload

File Management

Image Preview Function

File Download Function

Template Management

Template Creation, Editing and Management Interface

Message Notification System

Real-time Message Popup Notifications

Message Click Navigation Function

Modification History View

Content Change History and Difference Comparison

Reference Function

Content Reference and Navigation

Auto-collapsing Floating Status Clock

Default Floating Clock Display

New Content Status Reminder

Modified Content Status Reminder

Client Configuration

Desktop client supports personalized configuration of window position, size, font, etc.

⭐ Get Full Source Code

🌟 Star to Access Private Repository!

This is a public demo version. To get access to the complete source code including:

• Desktop application source code
• Backend server implementation
• Complete project documentation
• Installation and deployment guides

https://github.com/benda1989/TeamShareNote

After starring, you will receive access to the private repository with full source code!