CusDeb Web Client exposes the whole CusDeb's functionality to users, including customizing OS images for wide variety of single-board computers.
CusDeb Web Client can be configured via the following environment variables (called parameters).
Parameter | Description | Default |
---|---|---|
BLACKMAGIC_URL |
The URL of the API endpoint provided by the Black Magic service. | ws://localhost:8002/bm/token/%token |
CUSDEB_ANONYMOUS_URL |
The address of the CusDeb Anonymous service. | http://localhost:8007 |
CUSDEB_API_URL |
The address of the CusDeb API service. | http://localhost:8001 |
CUSDEB_HELPIK_URL |
The address of the CusDeb Helpik service. | http://localhost:8005 |
CUSDEB_TZ_URL |
The address of the CusDeb Tz service. | http://localhost:8006 |
DOMINION_URL |
The URL of the API endpoint provided by the Dominion service. | ws://localhost:8003/dominion/token/%token |
HOST |
The address of the machine Webpack Dev Server is running on. It helps to check CusDeb Web Client on other devices in a local network. | 0.0.0.0 |
PORT |
The port which Webpack Dev Server is running on. | 8000 |
SENTRY_DSN |
A Sentry DSN (Data Source Name) to tell the Sentry SDK where to send events. |
-
Install Node 12.
-
Install dependencies by executing.
$ npm install
Note that CusDeb Web Client contains optional dependencies. Here is an alternative command to ignore them:
$ npm install --no-optional
-
Define environment variables in the
.env
file in the project root directory. -
Run Webpack Dev Server by executing.
$ npm run dev
See AUTHORS.
CusDeb Web Client is available under the Apache License, Version 2.0.