Ink, the official u-BMC WebUI

DEPRECATED

This repository is deprecated. All current development has moved to the main u-bmc/u-bmc repository.

Requirements

yarn and Node.js. To run the :ci scripts a running docker daemon is required as well.

Use your Distributions or operating systems default way of installing these two.

Developing

While the project can be built and tested with yarn in your local environment alone, it is recommended to also use the XXX:ci scripts. The scripts suffixed with ci wrap the non :ci script in Dagger. Dagger is used for our CI and makes testing with Vitest and Playwright easier, as it uses Microsofts official images for that.

First make sure all dependecies are installed:

yarn install

To start a local development server:

yarn run dev

To test the written code first run the linters:

yarn run lint

Afterwards run the tests:

yarn run test

Building

To create a production version of your app:

yarn run build

You can preview the production build with:

yarn run preview

Each script can be run in any order. By using Wireit under the hood the scripts always make sure all requirements are met.