akillibulut/coriolis-web: Cloud Migration Web UI @ 007b40e2e5fbba107f5f8528d477fa9315e50c81

Cloud Migration Web UI

Sergiu Miclea 007b40e2e5 Docker file upgrade Node version from 16 to 18		2 anni fa
.github	265079fa84 Add GitHub Workflow action for code validation	3 anni fa
.storybook	4a7432971b Add unit tests	4 anni fa
.vscode	3dc8fa6372 Revamp the entire source code style and formatting	3 anni fa
private	16bf1eb6fb Add Jest unit testing framework	4 anni fa
public	2c6427f7d1 Move typing system from 'flow' to 'typescript'	5 anni fa
server	7fb6073cf6 Add LXD provider logo variants and label	2 anni fa
src	ccc5ad6d40 Add "WARNING" as a task dynamic status	2 anni fa
tests	4a7432971b Add unit tests	4 anni fa
.dockerignore	007b40e2e5 Docker file upgrade Node version from 16 to 18	2 anni fa
.editorconfig	0d39a85837 Coriolis with Atomic design implementation	8 anni fa
.eslintrc.js	3dc8fa6372 Revamp the entire source code style and formatting	3 anni fa
.gitignore	d7380b0e59 Show Setup page when launching for the first time	4 anni fa
.prettierrc	3dc8fa6372 Revamp the entire source code style and formatting	3 anni fa
Dockerfile	007b40e2e5 Docker file upgrade Node version from 16 to 18	2 anni fa
LICENSE	0d39a85837 Coriolis with Atomic design implementation	8 anni fa
README.md	f23a4b843f Fix missing images in `README.md`	3 anni fa
babel.config.js	faccd2bdc3 Apply the new code style changes to root files	3 anni fa
config.ts	7fb6073cf6 Add LXD provider logo variants and label	2 anni fa
cypress.json	32b0c10d24 Increased requestTimeout to 10s	7 anni fa
jest.config.ts	faccd2bdc3 Apply the new code style changes to root files	3 anni fa
package.json	84c4d9eebc Bump jszip from 3.7.1 to 3.8.0	3 anni fa
tsconfig.json	4a7432971b Add unit tests	4 anni fa
ui-mod-sample.json	257c052529 Add ability to set services URLs using MOD_JSON	6 anni fa
webpack.common.js	faccd2bdc3 Apply the new code style changes to root files	3 anni fa
webpack.dev.js	faccd2bdc3 Apply the new code style changes to root files	3 anni fa
webpack.prod.js	faccd2bdc3 Apply the new code style changes to root files	3 anni fa
yarn.lock	4b180bae31 Bump postcss from 8.4.5 to 8.4.31	2 anni fa

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>'
CA_FINGERPRINT='<path to CA fingerprint file used by metal hub agent>'

README.md