/jsparrow.github.io

Homepage for the jSparrow project, see https://jsparrow.github.io

Primary LanguageShell

About this repository

This is the documentation site for jSparrow!

jsaprrow documentation

How to contribute

Fork this repository, make changes and when you are done with them send us a pull request. Thank you.

Vuepress reference guide

Vuepress documentation

Edit guide

We recommend to use yarn for this project, feel free to use npm if you feel more comfortable.

Installing yarn

Install yarn as described on their website:

https://yarnpkg.com/lang/en/docs/install/#debian-stable

Trouble shooting

events.js:1xx
      throw er; // Unhandled 'error' event
      ^

This error might be solved as follows:

echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p

Source: jestjs/jest#3254 (comment)

Installing project dependencies

All required dependencies can be installed by executing the following:

yarn install

Run development server

To start a local development server, simply execute the following:

yarn run dev