akillibulut/coriolis-web: Cloud Migration Web UI @ a0cd54c3f8db3613e3321ad73c5afff16fd8a464

Cloud Migration Web UI

Daniel Vincze a0cd54c3f8 Merge pull request #670 from smiclea/import-absolute-paths		4 年之前
.githooks	d5fd34d304 Add custom provider names using the config file	4 年之前
.storybook	781ad82f8a Import modules using absolute paths	4 年之前
.vscode	781ad82f8a Import modules using absolute paths	4 年之前
private	2c6427f7d1 Move typing system from 'flow' to 'typescript'	5 年之前
public	2c6427f7d1 Move typing system from 'flow' to 'typescript'	5 年之前
server	e9628bbe33 Add command to test the source code for release	4 年之前
src	70b8671a5e Add custom ESLint code style rule for imports	4 年之前
.dockerignore	2c6427f7d1 Move typing system from 'flow' to 'typescript'	5 年之前
.editorconfig	0d39a85837 Coriolis with Atomic design implementation	8 年之前
.eslintignore	46e204a1df Upgrade eslint to the latest version	4 年之前
.eslintrc	70b8671a5e Add custom ESLint code style rule for imports	4 年之前
.gitignore	2c6427f7d1 Move typing system from 'flow' to 'typescript'	5 年之前
Dockerfile	46e204a1df Upgrade eslint to the latest version	4 年之前
LICENSE	0d39a85837 Coriolis with Atomic design implementation	8 年之前
README.md	e9628bbe33 Add command to test the source code for release	4 年之前
babel.config.js	2c6427f7d1 Move typing system from 'flow' to 'typescript'	5 年之前
config.ts	ec10976e34 Add ovirt / olvm plugin support	4 年之前
cypress.json	32b0c10d24 Increased requestTimeout to 10s	7 年之前
package.json	e9628bbe33 Add command to test the source code for release	4 年之前
tsconfig.json	781ad82f8a Import modules using absolute paths	4 年之前
ui-mod-sample.json	257c052529 Add ability to set services URLs using MOD_JSON	6 年之前
webpack.common.js	781ad82f8a Import modules using absolute paths	4 年之前
webpack.dev.js	2c6427f7d1 Move typing system from 'flow' to 'typescript'	5 年之前
webpack.prod.js	8c551ed635 Add high quality source maps to production builds	4 年之前
yarn.lock	70b8671a5e Add custom ESLint code style rule for imports	4 年之前

Web GUI for coriolis

Install instructions

node and yarn are required
clone repo
run yarn install or yarn install --production to install packages and dependencies for development or production mode
set CORIOLIS_URL environment variable

Build instructions

run yarn build
run yarn start to start the server

Your server will be running at http://localhost:3000/ (the port is configurable through PORT environment variable)

Testing

unit tests can be run using yarn test
run yarn test-release to check for Typescript and ESLint errors, to run the unit tests and to build and start a production build.

Development mode

set env. variable NODE_MODE='development'
run yarn client-dev to start local development server (starts on port 3001)
run yarn server-dev to 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

Modding

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.

Environment variables

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>'

README.md