4. Developer Documentation

Developer Documentation

This part of the documentation focusses on topics relevant to people who want to develop on or with the prod toolkit.

Getting & working with the source

Fetch submodules

To fetch all submodules (to fetch the modules), execute the following:

git submodule update --init --recursive

Install dependencies and build the toolkit

To download all dependencies and build the toolkit run:

npm install
npm run build

Building modules

To make sure all the modules are correctly built and installed, use the following command:

npm run build:modules

This will make sure that all modules are installed and built correctly. If you want to only run for a single module, have a look at the folder name of the module, and then run:

npm run build:modules module-league-static

Setting up git hooks

In order to set up a git pre-commit hook, that will make sure that the code style conforms to the guideline before you commit, run:

npm run setuphooks