Getting started



Best to install NodeJS via asdf (not supported for Windows). This allows you to easily switch to a new Node version, if it is released.

git clone ~/.asdf --branch v0.8.0
# Add the following line to ~/.bash_profile
. $HOME/.asdf/

Add nodejs plugin

# Dependencies on gpg and GNU core utils
brew install coreutils gpg
asdf plugin-add nodejs
bash -c '${ASDF_DATA_DIR:=$HOME/.asdf}/plugins/nodejs/bin/import-release-team-keyring'

Once asdf & nodejs plugin are installed, you can just run:

asdf install
npm install


Test are run with jest. Plugin can be installed for vscode vscode-jest. This allows you to easily run/debug tests from within vscode. Tests can also be executed via npm:

npm run test


Parcel is used to build the project. You can build the project via npm:

npm run build


In order to run the documentation you need to install Jekyll, you can do this by following the instructions on the official Jekyll documentation

After having installed Ruby and running bundle install you can get the markiting site/documentation up and running via npm:

npm run dev:site


Deploy is done via Gitlab on Firebase Hosting. An example integration can be found on the homepage

Overview CLI Commands

  • npm install: Installs dependencies

  • npm run dev: Run a development server

  • npm run dev:site: Run a development server for the marketing site and docs

  • npm run build: Production-ready build

  • npm run lint: Pass TypeScript files using TSLint

  • npm run test: Run Jest and Enzyme with enzyme-adapter-preact-pure for your tests