hub / github.com/streetwriters/notesnook

github.com/streetwriters/notesnook @3.4.4-android sqlite

repository ↗ · DeepWiki ↗ · release 3.4.4-android ↗

11,065 symbols 35,673 edges 1,477 files 501 documented · 5%

README

Notesnook

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

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:

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.
React — the whole front-end across all platforms is built using React.
React Native — For mobile apps we are using React Native
Electron — For desktop app
NPM — listed here because we don't use Yarn or PNPM or XYZ across any of our projects.

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:

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

Additional Resources

Extension points exported contracts — how you extend this code

ILogReporter (Interface)

(no doc) [16 implementers]

packages/logger/src/types.ts

ICollection (Interface)

(no doc) [53 implementers]

packages/core/src/collections/collection.ts

Driver (Interface)

(no doc) [26 implementers]

apps/web/src/common/sqlite/index.ts

IStreamable (Interface)

(no doc) [5 implementers]

packages/crypto/src/interfaces.ts

Gateway (Interface)

(no doc) [5 implementers]

extensions/web-clipper/src/common/bridge.ts

TestMode (Interface)

(no doc) [4 implementers]

apps/desktop/__tests__/electron-test/test-mode.ts

ISodium (Interface)

(no doc) [3 implementers]

packages/sodium/src/types.ts

IStreamableFS (Interface)

(no doc) [2 implementers]

packages/streamable-fs/src/interfaces.ts

Core symbols most depended-on inside this repo

called by 1937

apps/mobile/ios/extension.bundle/clipper.bundle.js

get

called by 1301

apps/web/src/interfaces/key-value.ts

set

called by 761

apps/web/src/interfaces/key-value.ts

apply

called by 593

packages/editor/src/utils/batch-attribute-step.ts

called by 393

apps/mobile/ios/extension.bundle/clipper.bundle.js

push

called by 323

packages/core/src/logger.ts

add

called by 307

packages/core/src/api/vault.ts

slice

called by 303

apps/web/src/utils/streams/unzip-stream.ts

Shape

Method 4,842

Function 4,179

Class 1,786

Interface 238

Enum 20

Languages

TypeScript99%

Java1%

Modules by API surface

apps/web/public/pdf.worker.min.js3,457 symbols

apps/mobile/worker.js1,093 symbols

apps/web/src/common/sqlite/wa-sqlite-async.js117 symbols

apps/web/src/common/sqlite/wa-sqlite.js109 symbols

apps/web/src/common/sqlite/sqlite-types.ts102 symbols

packages/sodium/src/node.ts51 symbols

apps/web/src/interfaces/key-value.ts51 symbols

apps/mobile/e2e/tests/utils.ts50 symbols

apps/web/__e2e__/models/note-properties.model.ts44 symbols

packages/core/src/api/lookup.ts42 symbols

apps/web/src/interfaces/file-store.ts42 symbols

apps/web/src/common/sqlite/WebLocks.js42 symbols

Dependencies from manifests, versioned

@ammarahmed/notifee-react-native7.4.12 · 1×

@ammarahmed/react-native-background-fetch4.2.3 · 1×

@ammarahmed/react-native-eventsource1.1.0 · 1×

@ammarahmed/react-native-fingerprint-scanner5.0.1 · 1×

@ammarahmed/react-native-share-extension2.9.5 · 1×

@ammarahmed/react-native-sodium1.6.8 · 1×

@ammarahmed/react-native-upload6.33.0 · 1×

@azure/core-asynciterator-polyfill1.0.2 · 1×

@babel/core7.22.5 · 1×

@babel/eslint-parser7.28.5 · 1×

@babel/plugin-proposal-class-properties7.16.7 · 1×

@babel/plugin-transform-unicode-property-regex7.27.1 · 1×

For agents

$ claude mcp add notesnook \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact