Cloud Migration Web UI

Nashwan Azhari f9bc764058 Merge pull request #578 from smiclea/fix-minion-mapping vor 5 Jahren
.githooks 60018b7224 Fix some ESLint issues (mostly spacing) vor 5 Jahren
.storybook 2c6427f7d1 Move typing system from 'flow' to 'typescript' vor 5 Jahren
.vscode 054aa88102 Add ability to debug the project from VS Code vor 5 Jahren
private 2c6427f7d1 Move typing system from 'flow' to 'typescript' vor 5 Jahren
public 2c6427f7d1 Move typing system from 'flow' to 'typescript' vor 5 Jahren
server 2c6427f7d1 Move typing system from 'flow' to 'typescript' vor 5 Jahren
src f9bc764058 Merge pull request #578 from smiclea/fix-minion-mapping vor 5 Jahren
.dockerignore 2c6427f7d1 Move typing system from 'flow' to 'typescript' vor 5 Jahren
.editorconfig 0d39a85837 Coriolis with Atomic design implementation vor 8 Jahren
.eslintignore 2c6427f7d1 Move typing system from 'flow' to 'typescript' vor 5 Jahren
.eslintrc eda0875725 Add Coriolis Regions support to all providers vor 5 Jahren
.gitignore 2c6427f7d1 Move typing system from 'flow' to 'typescript' vor 5 Jahren
Dockerfile 2c6427f7d1 Move typing system from 'flow' to 'typescript' vor 5 Jahren
LICENSE 0d39a85837 Coriolis with Atomic design implementation vor 8 Jahren
README.md 054aa88102 Add ability to debug the project from VS Code vor 5 Jahren
babel.config.js 2c6427f7d1 Move typing system from 'flow' to 'typescript' vor 5 Jahren
config.ts dff8df5cca Make the admin role name configurable vor 5 Jahren
cypress.json 32b0c10d24 Increased requestTimeout to 10s vor 7 Jahren
package.json 13dec6098f Fix NPM package security alert vor 5 Jahren
tsconfig.json 2c6427f7d1 Move typing system from 'flow' to 'typescript' vor 5 Jahren
ui-mod-sample.json 257c052529 Add ability to set services URLs using MOD_JSON vor 6 Jahren
webpack.common.js 2c6427f7d1 Move typing system from 'flow' to 'typescript' vor 5 Jahren
webpack.dev.js 2c6427f7d1 Move typing system from 'flow' to 'typescript' vor 5 Jahren
webpack.prod.js 2c6427f7d1 Move typing system from 'flow' to 'typescript' vor 5 Jahren
yarn.lock 13dec6098f Fix NPM package security alert vor 5 Jahren

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>'