Issues detailing bugs, missing features, and general feedback are most welcome.
Before submitting a pull request, opening an issue regarding the planned development can be useful to allow for some discussion before time and effort are invested.
Building the module requires a recent version of node to be installed.
Dependencies can be installed by running
npm ciBuilding the module will create a dist directory whose contents can be read and used by Foundry.
A one-off build, which will create a minified and production ready result, can be created with
npm run buildWhile developing, the build process can also be started as a watch job waiting for file changes and re-building the module as necessary by running Afterwards, when actively developing the module, a development server can be started with:
npm run serveThe development server will automatically reload the page when changes are made, or hot-reloads them when possible.
The dist directory created by building the package can be linked or copied into Foundry's Data/modules directory as quench.
The name of the directory is important, as diverging from the module's name will cause Foundry not to recognise the module.
The regular build process does not check the TypeScript code the way the regular compiler does. To still receive the benefits of type checking, you can run
npm run lintThis will lint all files using ESLint and run TypeScript's tsc.
The module's documentation can be generated by running
npm run docs # to build them once
npm run docs:watch # to watch for changes and rebuild them automatically