Notesnook

A fully open source & end-to-end encrypted note taking alternative to Evernote.

Stars
7.44K
Forks
419
Open issues
491
Closed issues
2.76K
Last release
3 months ago
Last commit
3 months ago
Watchers
7.44K
Total releases
147
Total commits
10.8K
Open PRs
34
Closed PRs
538
Repo URL
Platform
License
gpl-3.0
Category
Usecase
Notetaking
Offers premium version?
NO
Proprietary?
NO
About

Notesnook An end-to-end encrypted note taking alternative to Evernote.

Website | About us | Roadmap | Downloads | Twitter | Discord

Overview

Notesnook is a free (as in speech) & open-source note-taking app focused on user privacy & ease of use. To ensure zero knowledge principles, Notesnook encrypts everything on your device using XChaCha20-Poly1305 & Argon2.

Notesnook is our proof that privacy does not (always) have to come at the cost of convenience. We aim to provide users peace of mind & 100% confidence that their notes are safe and secure. The decision to go fully open source is one of the most crucial steps towards that.

This repository contains all the code required to build & use the Notesnook web, desktop & mobile clients. If you are looking for a full feature list or screenshots, please check the website.

Developer guide Technologies & languages

Notesnook is built using the following technologies:

  1. JavaScript/Typescript — this repo is in a hybrid state. A lot of the newer code is being written in Typescript & the old code is slowly being ported over.
  2. React — the whole front-end across all platforms is built using React.
  3. React Native — For mobile apps we are using React Native
  4. Electron — For desktop app
  5. NPM — listed here because we don't use Yarn or PNPM or XYZ across any of our projects.
  6. Nx — maintaining monorepos is hard but Nx makes it easier.

Note: Each project in the monorepo contains its own architecture details which you can refer to.

Monorepo structure

Name Path Description

@notesnook/web /apps/web Web client

@notesnook/desktop /apps/desktop Desktop client

@notesnook/mobile /apps/mobile Android/iOS clients

@notesnook/web-clipper /extensions/web-clipper Web clipper

@notesnook/core /packages/core Shared core between all platforms

@notesnook/crypto /packages/crypto Cryptography library wrapper around libsodium

@notesnook/clipper /packages/clipper Web clipper core handling everything related to actual page clipping

@notesnook/editor /packages/editor Notesnook editor + all extensions

@notesnook/editor-mobile /packages/editor-mobile A very thin wrapper around @notesnook/editor for mobile clients

@notesnook/logger /packages/logger Simple & pluggable logger

@notesnook/sodium /packages/sodium Wrapper around libsodium to support Node.js & Browser

@notesnook/streamable-fs /packages/streamable-fs Streaming interface around an IndexedDB based file system

@notesnook/theme /packages/theme The core theme used in web & desktop clients

Contributing guidelines

If you are interested in contributing to Notesnook, I highly recommend checking out the contributing guidelines. You'll find all the relevant information such as style guideline, how to make a PR, how to commit etc., there.

Support & help

You can reach out to us via:

  1. Email
  2. Discord
  3. Twitter
  4. Create an issue

We take all queries, issues and bug reports that you might have. Feel free to ask.

Additional Resources

Alternative Projects

Subscribe to Open Source Businees Newsletter

Twice a month we will interview people behind open source businesses. We will talk about how they are building a business on top of open source projects.

We'll never share your email with anyone else.