Code Monkey home page Code Monkey logo

note's Introduction

Collaborative Note App

Welcome to the Collaborative Note App repository! This is an open-source project aimed at providing a self-hosted collaborative note-taking experience. You can easily set it up on your own server or try it out instantly using the provided link.

Try it out!

Visit https://note.toolstack.run and add your note ID after the slash to get started. It's that simple! You can also easily lock your notes with a password for added security.

Features

  • Real-time Collaboration: Powered by PartyKit, enabling seamless collaboration on your notes.
  • Self-hosted: You have full control over your data by hosting it on your own server.
  • Password Protection: Secure your notes with passwords for privacy.
  • React + Vite: Built with modern web technologies for optimal performance.

How it Works

The notes in this project are saved using PartyKit's infrastructure, providing globally distributed, stateful, on-demand, and programmable web servers. Each note instance (referred to as a "Party") is backed by a Cloudflare Durable Object, ensuring reliability and scalability.

PartyKit servers are fully programmable in TypeScript, JavaScript, and can even be extended with WebAssembly modules for advanced functionality. Additionally, PartyKit allows for on-demand creation of instances, ensuring minimal start-up time and efficient resource utilization.

How is it Reliable?

  • Stateful Architecture: Each note instance maintains its state, ensuring consistency and reliability.
  • Globally Distributed: Leveraging Cloudflare's edge network, notes are hosted in hundreds of data centers globally, providing reliability and low-latency access.

Technologies Used

  • React
  • Vite
  • PartyKit
  • Tiptap Editor

Contributions

Contributions to this project are welcome! Whether it's bug fixes, feature enhancements, or documentation improvements, feel free to open an issue or submit a pull request.

Demo

Check out the live demo here.

Credits

Twitter Announcement

Check out the Twitter announcement here.


Feel free to explore the codebase, contribute, and create your own collaborative note-taking experience!

Todos

  • Add Pocketbase.io provider for storage backup for notes.
  • Add AI capabilities.

note's People

Contributors

amirrezasalimi avatar abolfazlnik avatar

Stargazers

 avatar Hadi avatar Mike Oristian avatar Rajiv Sinclair avatar  avatar  avatar amir  avatar

Watchers

Rajiv Sinclair avatar  avatar  avatar

Forkers

abolfazlnik

note's Issues

storage location

You don't explain where the note is stored, If it is local storage, you should mention that.

If it is stored on a central server, that would be good to mention.

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.