Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.88 KB

README.md

File metadata and controls

41 lines (30 loc) · 1.88 KB
Raw

DeepNotes

Website: https://deepnotes.app

DeepNotes is an open source, end-to-end encrypted infinite canvas tool with deep page nesting and realtime collaboration.

Why DeepNotes?

  • Infinite canvases: Free yourself from the big wall of text.
  • Deep page nesting: Explore concepts in all their complexity.
  • End-to-end encryption: Keep your notes well protected.
  • Realtime collaboration: Create groups to collaborate with your team.
  • Flexible note system: Organize your notes in whatever way you want.
  • Lifelong storage: Never lose your notes ever again.

Development

git clone https://github.com/DeepNotesApp/DeepNotes && cd DeepNotes && cp template.env .env && pnpm install && pnpm run repo:build && docker-compose up -d

(On Windows, use WSL or Git Bash to run the commands above)

  1. Run pnpm run dev to start the backend servers.
  2. Run one of these commands to start the frontend server:
    • pnpm run dev:spa to start the Single Page Application app.
    • pnpm run dev:ssr to start the Server Side Rendered app.
    • pnpm run dev:electron to start the Electron app.
    • pnpm run dev:android to start the Android app (requires Android Studio).
    • pnpm run dev:ios to start the iOS app (requires Xcode).

(If you use SPA or SSR, you must access the app through http://localhost:60379 by default. Other URLs won't work. You can configure the host and ports in the .env file.)

Special thanks to these libraries for making DeepNotes possible:

  • Vue.js: Reactivity, component system, and more
  • Quasar Framework: Cross-platform frontend framework
  • Yjs: Realtime collaboration
  • Tiptap: Rich text editor
  • KeyDB and Redis: Scalable shared memory and communication
  • And many more...