| title | Note Sync Now Overview |
|---|---|
| description | Repository overview and guided entry for running, understanding, and navigating the project. |
| permalink | /overview/ |
Note Sync Now is an end-to-end encrypted note synchronization project for experimenting with mnemonic-based recovery, real-time collaboration, and privacy-first multi-device sync.
- React + Vite client in
brave-sync-notes/client - Express + Socket.IO server in
brave-sync-notes/server - AES-256-based client-side encryption with mnemonic recovery flow
- GitHub Pages site for architecture, usage paths, deployment notes, and project updates
cd brave-sync-notes/server
npm ci
node index.js
cd ../client
npm ci
npm run devBackend defaults to http://localhost:3002; the Vite dev server usually runs on http://localhost:5173.
- Project docs: https://lessup.github.io/brave-sync-notes/
- Deployment & operations: https://lessup.github.io/brave-sync-notes/deployment/
- Contribution guide: https://lessup.github.io/brave-sync-notes/contributing/
- Start from the docs home for the navigation overview.
- Use the architecture page to understand the client/server split and sync flow.
- Use the deployment page before running or shipping changes.
- Use the contribution guide before opening a pull request.
MIT License