Skip to content

Dev setup

Programming knowledge required

While you can easily change configurations of existing templates or copy them, the development of the TDK itself requires programming knowledge, especially:

What you need on your machine

To build and run the toolkit locally, your machine needs:

  • Node.js 22 and Yarn 1 (the repository uses yarn@1.22.19)
  • A Unix-like shell — macOS or Linux. On Windows, use WSL2 or a Linux virtual machine with your favourite distribution.
  • Pandoc installed and available on your PATH (used for document conversion)
  • Git to clone the repository
  • PrinceXML, only if you want to export PDFs through PrinceXML

Install and run

The source is at gitlab.com/sciflow/development, on the development branch.

git clone -b development https://gitlab.com/sciflow/development.git
cd development
yarn && ./scripts/postinstall.sh

Then start the parts in separate terminals:

  1. yarn watch builds the libraries and rebuilds them when you change them.
  2. cd app && yarn start starts the app at http://localhost:4200.
  3. Start the server from VS Code with the launch configuration 1) Launch Server.

Note

Use cd app && yarn start to start the app. The yarn start script in the repository root currently points to the wrong workspace and does not work.