nickjfree / dashboard

Web UI for OneCloud

Yunion Dashboard

Yunion Dashboard is the web-based UI for OneCloud

README in Chinese

Developer Guide

Preparation

Make sure the following software is installed and added to the $PATH variable:

• Node.js 10.16+ (installation with nvm)
• Yarn 1.19.1+ (documentation)

or

Install yarn with npm:

npm install -g yarn

Fork the following repository, then clone dashboard main repository and install dependencies

• dashboard
• dashboard-common
• dashboard-module-compute
• dashboard-module-network
• dashboard-module-cloudenv
• dashboard-module-dashboard
• dashboard-module-monitor
• dashboard-module-storage

git clone https://github.com/<owner>/dashboard.git
cd dashboard
yarn
yarn setup:dev

Enter the prefix of the repository address as prompted, such as: https://github.com/yunionio

Note: If you are in China Mainland, execute the following command before running the command above for faster installation.

yarn config set registry https://registry.npm.taobao.org

Start Dashboard for development

If you want to configure the proxy, please create dev.server.config.js in the project root directory and export configuration

Please change the configuration according to your needs, the following is just an example

// dev.server.config.js
module.exports = {
  open: process.platform === 'darwin',
  port: 8080,
  proxy: {
    '/api': {
      target: 'https://192.168.1.10',
      ws: true,
      changeOrigin: true,
      secure: false,
    },
  },
}

More configuration

yarn serve

Now, you can open http://localhost:8080 to view

Build Dashboard for production

yarn build

Other commands

Switch all modules to the specified version

yarn checkout <branch>

Update all modules

yarn sync <branch>