https://github.com/fred-gutierrez/snapnote

SnapNote is an open-source note-taking extension created with the goals of transparency, convenience, and most importantly, speed.
https://github.com/fred-gutierrez/snapnote

chrome-extension dark-mode dark-theme firefox-addon night-mode note-taking notes notes-app

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/fred-gutierrez/snapnote
• Owner: fred-gutierrez
• License: mit
• Created: 2023-11-14T00:07:26.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-20T00:27:06.000Z (12 months ago)
• Last Synced: 2024-04-14T03:06:05.036Z (9 months ago)
• Topics: chrome-extension, dark-mode, dark-theme, firefox-addon, night-mode, note-taking, notes, notes-app
• Language: TypeScript
• Homepage: https://snapnote-demo.vercel.app
• Size: 680 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Roadmap: ROADMAP.md

Awesome Lists containing this project

README

        


  


   

	

  

	
SnapNote

	


		Never skip a note.

    


    Demo: snapnote-demo.vercel.app

    


    


  

		

    


  


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](https://github.com/TypeCellOS/BlockNote)!



## 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](https://github.com/crxjs/chrome-extension-tools), React, TypeScript, Tailwind CSS, Redux, 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](ROADMAP.md) 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](https://github.com/fred-gutierrez/snapnote/blob/main/CONTRIBUTING.md#projects-architecture).

### 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](CONTRIBUTING.md) for directions.

## Roadmap

The roadmap can be found [here](ROADMAP.md).