Cloud Migration Web UI

Nashwan Azhari 114d1247e8 Merge pull request #606 from smiclea/tasks-sort 5 anni fa
.githooks 60018b7224 Fix some ESLint issues (mostly spacing) 5 anni fa
.storybook 2c6427f7d1 Move typing system from 'flow' to 'typescript' 5 anni fa
.vscode 0ced540cbd Remove extra '/' from dashboard activity path 5 anni fa
private 2c6427f7d1 Move typing system from 'flow' to 'typescript' 5 anni fa
public 2c6427f7d1 Move typing system from 'flow' to 'typescript' 5 anni fa
server 2c6427f7d1 Move typing system from 'flow' to 'typescript' 5 anni fa
src 114d1247e8 Merge pull request #606 from smiclea/tasks-sort 5 anni fa
.dockerignore 2c6427f7d1 Move typing system from 'flow' to 'typescript' 5 anni fa
.editorconfig 0d39a85837 Coriolis with Atomic design implementation 8 anni fa
.eslintignore 2c6427f7d1 Move typing system from 'flow' to 'typescript' 5 anni fa
.eslintrc eda0875725 Add Coriolis Regions support to all providers 5 anni fa
.gitignore 2c6427f7d1 Move typing system from 'flow' to 'typescript' 5 anni fa
Dockerfile 2c6427f7d1 Move typing system from 'flow' to 'typescript' 5 anni fa
LICENSE 0d39a85837 Coriolis with Atomic design implementation 8 anni fa
README.md 054aa88102 Add ability to debug the project from VS Code 5 anni fa
babel.config.js 2c6427f7d1 Move typing system from 'flow' to 'typescript' 5 anni fa
config.ts dff8df5cca Make the admin role name configurable 5 anni fa
cypress.json 32b0c10d24 Increased requestTimeout to 10s 7 anni fa
package.json 1569a3bf34 Update task updates sorting and progress fields 5 anni fa
tsconfig.json 2c6427f7d1 Move typing system from 'flow' to 'typescript' 5 anni fa
ui-mod-sample.json 257c052529 Add ability to set services URLs using MOD_JSON 6 anni fa
webpack.common.js 2c6427f7d1 Move typing system from 'flow' to 'typescript' 5 anni fa
webpack.dev.js 2c6427f7d1 Move typing system from 'flow' to 'typescript' 5 anni fa
webpack.prod.js 2c6427f7d1 Move typing system from 'flow' to 'typescript' 5 anni fa
yarn.lock a0914293e9 Bump axios from 0.19.2 to 0.21.1 5 anni fa

README.md

Coriolis Web

Web GUI for coriolis

CI Badge

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
  • e2e integration tests can be run using yarn e2e. First though, you have to create the private/cypress/config.js file using private/cypress/config.template.js as a template and then run yarn build and node server.

Development mode

  • set env. variable NODE_MODE='development'
  • run yarn ui-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>'