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 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

And that's it. You can run the tests to make sure everything is working as it should:

npm run test:core

Developer guide

The tech stack

We try to keep the stack as lean as possible

1. Javascript
2. Jest: Testing framework

Running the tests

When you are done making the required changes, you need to run the tests. We use Jest as the testing framework & the tests can be run with a single command:

npm run test:core