mirror of
https://github.com/streetwriters/notesnook.git
synced 2026-09-01 19:49:54 +02:00
5e6caa7273
This is mostly because I am not 100% certain about how stable our own optimized version is. While it does perform a lot better, there is significant risk that things might break in production. To avoid that, I am replacing it with the upstream version which is much more heavily tested.
Notesnook Core
The shared core for building Notesnook on any platform.
Developer guide | How to build? | Run the tests
Build instructions
Before you start it is recommended that you read the contributing guidelines.
Setting up the development environment
Requirements:
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
- Javascript
- 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