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

Cloud Migration Web UI

Sergiu Miclea dae21ddb63 Merge pull request #710 from cloudbase/dependabot/npm_and_yarn/terser-4.8.1		3 tahun lalu
.githooks	d5fd34d304 Add custom provider names using the config file	4 tahun lalu
.storybook	4a7432971b Add unit tests	4 tahun lalu
.vscode	a09a518eec Add default migration image mappings	4 tahun lalu
private	16bf1eb6fb Add Jest unit testing framework	4 tahun lalu
public	2c6427f7d1 Move typing system from 'flow' to 'typescript'	5 tahun lalu
server	228cce017c Add support for Coriolis Metal Hub provider	4 tahun lalu
src	76d951f702 Merge pull request #705 from smiclea/network-mapping	3 tahun lalu
tests	4a7432971b Add unit tests	4 tahun lalu
.dockerignore	2c6427f7d1 Move typing system from 'flow' to 'typescript'	5 tahun lalu
.editorconfig	0d39a85837 Coriolis with Atomic design implementation	8 tahun lalu
.eslintignore	dcd390f482 Remove data test ID attributes	4 tahun lalu
.eslintrc	bd51776a95 Merge pull request #679 from smiclea/max-params	4 tahun lalu
.gitignore	d7380b0e59 Show Setup page when launching for the first time	4 tahun lalu
Dockerfile	46e204a1df Upgrade eslint to the latest version	4 tahun lalu
LICENSE	0d39a85837 Coriolis with Atomic design implementation	8 tahun lalu
README.md	6d089d5030 Rename NODE_MODE env. variable	4 tahun lalu
babel.config.js	6d089d5030 Rename NODE_MODE env. variable	4 tahun lalu
config.ts	da0a35de5c Display `client_secret` field as a password	4 tahun lalu
cypress.json	32b0c10d24 Increased requestTimeout to 10s	7 tahun lalu
jest.config.ts	4a7432971b Add unit tests	4 tahun lalu
package.json	c19856ca4e Merge pull request #709 from smiclea/fix-security	3 tahun lalu
tsconfig.json	4a7432971b Add unit tests	4 tahun lalu
ui-mod-sample.json	257c052529 Add ability to set services URLs using MOD_JSON	6 tahun lalu
webpack.common.js	781ad82f8a Import modules using absolute paths	4 tahun lalu
webpack.dev.js	2c6427f7d1 Move typing system from 'flow' to 'typescript'	5 tahun lalu
webpack.prod.js	8c551ed635 Add high quality source maps to production builds	4 tahun lalu
yarn.lock	fe5a1abf65 Bump terser from 4.8.0 to 4.8.1	3 tahun lalu

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_ENV='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_ENV='production'
CORIOLIS_URL='<your-coriolis-url>'
MOD_JSON='<path-to-json>'

README.md