Skip to content

Latest commit

 

History

History
53 lines (43 loc) · 3.93 KB

README.md

File metadata and controls

53 lines (43 loc) · 3.93 KB

Logo

SnapNote

Never skip a note.
Demo: snapnote-demo.vercel.app

Chrome Web Store Firefox Add-ons Edge Addons

SnapNote is an open-source note-taking extension created with the goals of transparency, convenience, and most importantly, speed.

Powered by the open-source block-based rich text editor BlockNote and, in the future, offering Milkdown as an option.

Dark Mode Screenshot

Motivation

This project was initially created with the realization that sometimes we need to take quick notes while navigating the web. We often use apps like Notion or Obsidian, but there are instances where we may not have the option to do so or, for something quick, lack the time to open the app and create a new note. SnapNote is designed for us, anytime, anywhere, with it installed, to take a note immediately in our browser and then transfer that information to our preferred apps when possible.

Architecture

The current technologies used for this project include CRXJS, React, TypeScript, Tailwind CSS, Font Awesome and Vite.

  • The goal is to keep the technology stack as simple as possible to ensure we maintain the core principle of speed. However, as always, the stack is subject to change and improvement.
  • For the backend, we are considering implementing Supabase to store credentials and notes. This is part of the roadmap and will be implemented down the line. We are very open to feedback regarding this subject.

If you would like to learn more about the code architecture guidelines, you can check them out here.

Packages

  • blocknote/core the engine containing types and elements essential for BlockNote to function.
  • blocknote/react the React UI component library designed for blocknote/core.

Contributing

We're delighted that you're considering contributing to this project. Every contribution matters, whether it's documentation, refactoring, adding new ideas/components, or anything else you believe would be a valuable addition. Please refer to the contributing guide for directions.

Roadmap

The roadmap can be found here.