https://github.com/tanja-4732/doublenote

(beta) - An Angular note taking app supporting both real-time and async collaboration using Markdown or a WYSIWYG editor, optimised for peer-to-peer usage with optional commit-based versioning
https://github.com/tanja-4732/doublenote

angular collaboration docker docker-image express markdown-editor nodejs note-taking notebook notes notes-app offline-first peerjs progressive-web-app prosemirror service-worker single-page-app typescript versioning webrtc

Last synced: 27 days ago
JSON representation

(beta) - An Angular note taking app supporting both real-time and async collaboration using Markdown or a WYSIWYG editor, optimised for peer-to-peer usage with optional commit-based versioning

• Host: GitHub
• URL: https://github.com/tanja-4732/doublenote
• Owner: Tanja-4732
• License: agpl-3.0
• Created: 2020-03-10T07:34:39.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-06-22T22:07:13.000Z (over 1 year ago)
• Last Synced: 2024-05-13T16:25:38.003Z (6 months ago)
• Topics: angular, collaboration, docker, docker-image, express, markdown-editor, nodejs, note-taking, notebook, notes, notes-app, offline-first, peerjs, progressive-web-app, prosemirror, service-worker, single-page-app, typescript, versioning, webrtc
• Language: TypeScript
• Homepage: https://DoubleNote.tanja.pw
• Size: 5.65 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  



# DoubleNote

A note taking app focused on ease of use and user freedom.

This is a new project (currently in beta); its development status is far away from a 1.0 release.

To give it a try, see the `master` branch deployed here:  (powered by CloudFlare pages).  

Notice: This is only the frontend served statically. Some (planned) features are only available using the backend server.

## (Planned) Features

_See the newest plans in the [5th iteration of the frontend README](/frontend/README.md#5th-iteration)_

- Note-taking with both Markdown and WYSIWYG editors (ProseMirror)

- Full offline support (Progressive Web App)

- Peer-to-peer real-time collaboration (WebRTC, no backend server needed)

- Git-like version control (commits, branches, tags, reused objects)

- Two types of notebooks

  - Recursive categories with pages containing text boxes and free-hand drawing (like OneNote)

  - Sequential blocks with nested pages capable of special data and tables (like Notion)

- Offline-capable import/export functionality (JSON)

- Origin-agnostic migration support (for DoubleNote instances on different hosts)

- Optional cloud storage (server-side software) with user accounts and shared permissions

## Usage

If you want to try the application before installing via NPM or Docker, you can check it out [here on CloudFlare Pages](https://DoubleNote.tanja.pw/).

Both the frontend and the backend have their respective packages on NPM: [doublenote-frontend](https://npmjs.org/package/doublenote-frontend) (contains the compiled frontend without any non-dev dependencies), and the [doublenote-backend](https://npmjs.org/package/doublenote-backend), which contains the compiled backend (depending on Express).

## Development

For more information on how to develop this application, push it beyond its current capabilities and realize your own features and/or bug fixes, see the [development section of the frontend README.md](/frontend/README.md#development)

## Further reading

For information about the frontend, see the [frontend README.md](/frontend/README.md).  

For information about the backend, see the [backend README.md](/backend/README.md).  

For information about the `doublenote` NPM package, see the [package README.md](/package/README.md).

## Licence & Copyright

Copyright (c) 2020-2023 Tanja-4732. All rights reserved.

![AGPL v3: Free as in Freedom](https://www.gnu.org/graphics/agplv3-with-text-162x68.png)

DoubleNote is free software: you can redistribute it and/or modify it under the terms of the [GNU Affero General Public License](/LICENSE.md) as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

DoubleNote is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the [GNU Affero General Public License](/LICENSE.md) for more details.

You should have received a copy of the [GNU Affero General Public License](/LICENSE.md) along with DoubleNote. If not, see .

This project (including its source code and its documentation) is released under the terms of the [GNU Affero General Public License](/LICENSE.md).