Skip to content

Latest commit

 

History

History
 
 

desktop

Notesnook desktop screenshot

Notesnook Desktop

The desktop app is built using Electron & Typescript.

Downloads | Developer guide | How to build?

Getting started

Build instructions

Before you start, it is recommended that you read the contributing guidelines.

Setting up the development environment

Requirements:

  1. Node.js
  2. git
  3. NPM (not yarn or pnpm)

Before you can do anything, you'll need to install Node.js v16 or later on your system.

Once you have completed the setup, the first step is to clone the monorepo:

git clone https://github.com/streetwriters/notesnook.git

# change directory
cd notesnook

Once you are inside the ./notesnook directory, run the preparation step:

# this might take a while to complete
npm install

Now you can finally start the desktop app:

npm run start:desktop

Developer guide

The tech stack

We try to keep the stack as lean as possible:

  1. Electron
  2. tRPC: for cross-communication between the web & desktop parts
  3. zod: for runtime typechecking
  4. yargs: for CLI argument parsing