GithubHelp home page GithubHelp logo

sebtota / tiptapsn Goto Github PK

View Code? Open in Web Editor NEW
7.0 3.0 2.0 5.52 MB

TipTapSN is the first Collaborative Note Editor for Standard Notes

JavaScript 31.36% HTML 1.51% Vue 67.14%
collaborative-editing standardnotes webrtc

tiptapsn's Introduction

TipTapSN

Note: This editor is still in beta and may contain bugs.

TipTapSN is a collaborative note editor built for Standard Notes using the TipTap WYSIWYG editor. The key benefit of TipTapSN is the collaborative feature which allows you to work on a note with multiple users.

Watch this video for an example.

Sharing

Note Editing

  • Users can see everyone elses cursor, including what they currently have selected
  • Each users history is their own
    • Undo/Redo buttons only undo/redo your own work, not the work of others
  • Users are notified when the host leaves

Possible Downsides

  • Because you can only edit your own note history, you can not backtrack an edit made by another user.
    • This is partially mitigated by Standard Notes History feature, but this only takes snapshots at certain intervals. Please be aware of this and only share your notes with individuals you trust.
  • WebRTC has been shown to have the ability to leak your IP address even if you are using a VPN. You can check if your browser and/or VPN leaks your IP address online.

Benefits

  • Once the connection between the users has been established, all your communication is P2P and never travels through any servers.
  • No data communication servers means that you don't have to worry about server outages or servers being outright shut down.
  • WebRTC is supported by most modern desktop and mobile browsers

How to install the editor in Standard Notes

  • Open the Standard Notes application and click the 'Extensions` button.
  • Click Import Extension
  • Paste this URL into the text box
https://sebtota.github.io/TipTapSN/ext.json
  • Click Enter

Development

Project setup

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Lints and fixes files

npm run lint

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.