akillibulut/coriolis-web: Cloud Migration Web UI @ 3370f782d9adc8dd76ac2d5760b0ba344ccd4ee3

Cloud Migration Web UI

dependabot[bot] 3370f782d9 Bump @babel/traverse from 7.23.0 to 7.23.2		2 vuotta sitten
.github	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	2 vuotta sitten
.storybook	4a7432971b Add unit tests	4 vuotta sitten
.vscode	3dc8fa6372 Revamp the entire source code style and formatting	3 vuotta sitten
.yarn	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	2 vuotta sitten
private	16bf1eb6fb Add Jest unit testing framework	4 vuotta sitten
public	2c6427f7d1 Move typing system from 'flow' to 'typescript'	5 vuotta sitten
server	7fb6073cf6 Add LXD provider logo variants and label	2 vuotta sitten
src	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	2 vuotta sitten
tests	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	2 vuotta sitten
.dockerignore	007b40e2e5 Docker file upgrade Node version from 16 to 18	2 vuotta sitten
.editorconfig	0d39a85837 Coriolis with Atomic design implementation	8 vuotta sitten
.eslintrc.js	3dc8fa6372 Revamp the entire source code style and formatting	3 vuotta sitten
.gitignore	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	2 vuotta sitten
.prettierrc	3dc8fa6372 Revamp the entire source code style and formatting	3 vuotta sitten
.yarnrc.yml	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	2 vuotta sitten
Dockerfile	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	2 vuotta sitten
LICENSE	0d39a85837 Coriolis with Atomic design implementation	8 vuotta sitten
README.md	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	2 vuotta sitten
babel.config.js	faccd2bdc3 Apply the new code style changes to root files	3 vuotta sitten
config.ts	7fb6073cf6 Add LXD provider logo variants and label	2 vuotta sitten
cypress.json	32b0c10d24 Increased requestTimeout to 10s	7 vuotta sitten
jest.config.ts	faccd2bdc3 Apply the new code style changes to root files	3 vuotta sitten
package.json	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	2 vuotta sitten
tsconfig.json	3df3ed01d4 Upgrade Yarn to modern (3.6.3) version	2 vuotta sitten
ui-mod-sample.json	257c052529 Add ability to set services URLs using MOD_JSON	6 vuotta sitten
webpack.common.js	faccd2bdc3 Apply the new code style changes to root files	3 vuotta sitten
webpack.dev.js	faccd2bdc3 Apply the new code style changes to root files	3 vuotta sitten
webpack.prod.js	faccd2bdc3 Apply the new code style changes to root files	3 vuotta sitten
yarn.lock	3370f782d9 Bump @babel/traverse from 7.23.0 to 7.23.2	2 vuotta sitten

Web GUI for coriolis

Install instructions

Install Node 18
clone repo
run corepack enable for yarn 3 support
run yarn install (development deps) or yarn workspaces focus --all --production (production deps)
set CORIOLIS_URL environment variable

Build instructions

Build the production version of the UI:

run npm run build
run npm run 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 npm run test
run npm run test-release to check for Typescript, ESLint and prettier errors. This will also run the unit tests and will try to build and start a production version. If eeverything is OK, it will revert to the development installation.

Development mode

set env. variable NODE_ENV='development'
run npm run client-dev to start local development server (starts on port 3001)
run npm run 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 npm run ... commands must be running in the background.

To debug the Node server using VS Code, run npm run server-debug instead of npm run server-dev.

You can view some of the UIs components in the Storybook by running npm run 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