akillibulut/coriolis-web: Cloud Migration Web UI @ stable/2210

Cloud Migration Web UI

Daniel Vincze 38c27121f8 Merge pull request #761 from smiclea/optional-props		преди 3 години
.github	265079fa84 Add GitHub Workflow action for code validation	преди 3 години
.storybook	4a7432971b Add unit tests	преди 4 години
.vscode	3dc8fa6372 Revamp the entire source code style and formatting	преди 3 години
private	16bf1eb6fb Add Jest unit testing framework	преди 4 години
public	2c6427f7d1 Move typing system from 'flow' to 'typescript'	преди 5 години
server	ba1c4912a9 Add Oracle PCA X9-2 Logos and Configuration	преди 3 години
src	370cc1e5a8 Support optional properties in BM server object	преди 3 години
tests	4a7432971b Add unit tests	преди 4 години
.dockerignore	2c6427f7d1 Move typing system from 'flow' to 'typescript'	преди 5 години
.editorconfig	0d39a85837 Coriolis with Atomic design implementation	преди 8 години
.eslintrc.js	3dc8fa6372 Revamp the entire source code style and formatting	преди 3 години
.gitignore	d7380b0e59 Show Setup page when launching for the first time	преди 4 години
.prettierrc	3dc8fa6372 Revamp the entire source code style and formatting	преди 3 години
Dockerfile	46e204a1df Upgrade eslint to the latest version	преди 4 години
LICENSE	0d39a85837 Coriolis with Atomic design implementation	преди 8 години
README.md	f23a4b843f Fix missing images in `README.md`	преди 3 години
babel.config.js	faccd2bdc3 Apply the new code style changes to root files	преди 3 години
config.ts	ba1c4912a9 Add Oracle PCA X9-2 Logos and Configuration	преди 3 години
cypress.json	32b0c10d24 Increased requestTimeout to 10s	преди 7 години
jest.config.ts	faccd2bdc3 Apply the new code style changes to root files	преди 3 години
package.json	84c4d9eebc Bump jszip from 3.7.1 to 3.8.0	преди 3 години
tsconfig.json	4a7432971b Add unit tests	преди 4 години
ui-mod-sample.json	257c052529 Add ability to set services URLs using MOD_JSON	преди 6 години
webpack.common.js	faccd2bdc3 Apply the new code style changes to root files	преди 3 години
webpack.dev.js	faccd2bdc3 Apply the new code style changes to root files	преди 3 години
webpack.prod.js	faccd2bdc3 Apply the new code style changes to root files	преди 3 години
yarn.lock	84c4d9eebc Bump jszip from 3.7.1 to 3.8.0	преди 3 години

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