Web GUI for coriolis
- node and yarn are required
- clone repo
- run
yarn installoryarn install --productionto install packages and dependencies for development or production mode - set
CORIOLIS_URLenvironment variable
- run
yarn build - run
yarn startto start the server
Your server will be running at http://localhost:3000/ (the port is configurable through PORT environment variable)
- unit tests can be run using
yarn test - e2e integration tests can be run using
yarn e2e. First though, you have to create theprivate/cypress/config.jsfile usingprivate/cypress/config.template.jsas a template and then runyarn buildandnode server.
- set env. variable
NODE_MODE='development' - run
yarn client-devto start local development server (starts on port 3001) - run
yarn server-devto start the express server in development mode
To debug the client code using VS Code, simply run the project's launch configuration from the 'Run' menu (Ctrl+Shift+D).
The last 2 yarn ... commands must be running in the background.
To debug the Node server using VS Code, run yarn server-debug instead of yarn server-dev.
You can view some of the UIs components in the Storybook by running yarn storybook
The UI can be modded externally using a .json modding file. A sample is available in the repo ui-mod-sample.json.
The path to the .json mod file needs to be set in MOD_JSON environment variable (ex.: MOD_JSON=/usr/ui-mod.json).
Any provider logos can be replaced using local logo images. The local image file paths need to be absolute.
You can specify one logo, in which case it will be scaled to all sizes. You can also specify logos for just a couple of the sizes, in which case the closest size to the one required will be used. Open ui-mod-sample.json for more details.
Any option from config.ts can be modified by adding the config field to the ui-mod-sample.json file.
All environment variables can be set in a .env file created in the root directory.
The following is the list of environment variables and their default values:
NODE_MODE='production'
CORIOLIS_URL='<your-coriolis-url>'
MOD_JSON='<path-to-json>'