Skip to content

A decentralized, peer-to-peer application for seamless note-sharing and collaboration. Users can either create a new note session or join an existing one using a unique key.

Notifications You must be signed in to change notification settings

Codesamp-Rohan/swarmnote

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 

Repository files navigation

swarmnote: P2P Note Collabaration

Overview

A decentralized, peer-to-peer application for seamless note-sharing and collaboration. Users can either create a new note session or join an existing one using a unique key. The app ensures real-time syncing, secure connections, and a lightweight, intuitive interface for hassle-free collaboration on notes. Perfect for brainstorming, sharing ideas, or collaborative writing!


Installation

Global Installation

npm i swarmnote-admin swarmnote-join -g

Create or Open Notes

  • new : To create a new note
  • open : To open an existing note
  • list: To see all the created notes on your system

To create a new note

swarmnote-admin new <note-name>

To open an existing note

swarmnote-admin open <note-name>

To see all the notes on your system

swarmnote-admin list

Join the Notes

To join you need the key of the notes room which is shown in it's GUI.

swarmnote-join <key>

Technologies Used

  • Frontend: HTML, CSS, JavaScript
  • Backend: Node.js
  • P2P Libraries: Hyperswarm, Hypercore-Crypto, b4a, Hypercore, bare-path

Contributing

We welcome contributions to swarmnote! Here's how you can contribute:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix:
    git checkout -b feature-name
  3. Commit your changes:
    git commit -m "Add feature-name"
  4. Push the changes and submit a pull request:
    git push origin feature-name

License

This project is licensed under the MIT License.


Contact

Have questions or suggestions? Reach out!

About

A decentralized, peer-to-peer application for seamless note-sharing and collaboration. Users can either create a new note session or join an existing one using a unique key.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published