mirror of
https://github.com/apache/cloudstack.git
synced 2025-10-26 08:42:29 +01:00
README: cleanup
Signed-off-by: Rohit Yadav <rohit.yadav@shapeblue.com>
This commit is contained in:
parent
22bca0c248
commit
f388e4eb0f
100
ui/README.md
100
ui/README.md
@ -1,6 +1,13 @@
|
|||||||
# CloudStack Primate
|
# CloudStack Primate
|
||||||
|
|
||||||
A progressive modern CloudStack Admin UI based on VueJS and Ant Design.
|
A modern role-based progressive CloudStack UI based on VueJS and Ant Design.
|
||||||
|
|
||||||
|
## Env and dependencies
|
||||||
|
|
||||||
|
- node
|
||||||
|
- webpack
|
||||||
|
- eslint
|
||||||
|
- @vue/cli ~3
|
||||||
|
|
||||||
Install tools and dependencies:
|
Install tools and dependencies:
|
||||||
|
|
||||||
@ -10,6 +17,13 @@ Install tools and dependencies:
|
|||||||
ncu -u # optional: upgrade dependencies
|
ncu -u # optional: upgrade dependencies
|
||||||
npm install
|
npm install
|
||||||
|
|
||||||
|
## Developing against CloudStack Env
|
||||||
|
|
||||||
|
Override the default `API_URL` to a running CloudStack management server:
|
||||||
|
|
||||||
|
cp .env.local.example .env.local
|
||||||
|
Change the `API_URL` in the `.env.local` file
|
||||||
|
|
||||||
Build and run:
|
Build and run:
|
||||||
|
|
||||||
npm start
|
npm start
|
||||||
@ -34,39 +48,9 @@ Fix issues and vulnerabilities:
|
|||||||
|
|
||||||
npm audit
|
npm audit
|
||||||
|
|
||||||
Override the default CloudStack API URL:
|
### Customisation
|
||||||
|
|
||||||
cp .env.local.example .env.local
|
- Theme: `vue.config.js`
|
||||||
Change the `API_URL` in the `.env.local` file
|
|
||||||
|
|
||||||
## History
|
|
||||||
|
|
||||||
The project was created by Rohit Yadav over several weekends during late 2018.
|
|
||||||
The base app layout was referenced from [Ant Design Pro
|
|
||||||
Vue](https://github.com/sendya/ant-design-pro-vue).
|
|
||||||
|
|
||||||
### Env and dependencies
|
|
||||||
|
|
||||||
- node
|
|
||||||
- webpack
|
|
||||||
- eslint
|
|
||||||
- @vue/cli ~3
|
|
||||||
- [ant-design-vue](https://github.com/vueComponent/ant-design-vue) - Ant Design Of Vue
|
|
||||||
- [vue-cropper](https://github.com/xyxiao001/vue-cropper) - Picture edit
|
|
||||||
- [@antv/g2](https://antv.alipay.com/zh-cn/index.html) - AntV G2
|
|
||||||
- [Viser-vue](https://viserjs.github.io/docs.html#/viser/guide/installation) - Antv/G2 of Vue
|
|
||||||
- [Fontawesome](https://github.com/FortAwesome/vue-fontawesome)
|
|
||||||
|
|
||||||
### Other
|
|
||||||
|
|
||||||
- [Vue-cli3](https://cli.vuejs.org/guide/) used by the project.
|
|
||||||
- Disable Eslint (not recommended): remove `eslintConfig` field in `package.json`
|
|
||||||
|
|
||||||
- Easy-Mock used by project,[easy-mock](https://www.easy-mock.com/) Project API Data [DO NOT CHANGE THE INTERFACE](https://www.easy-mock.com/project/5b7bce071f130e5b7fe8cd7d),If you want to modify, please fork [ANTD-PRO-Easy-Mock-API.zip](https://github.com/sendya/ant-design-pro-vue/files/2682711/ANTD-PRO-Easy-Mock-API.zip) and running to your server.
|
|
||||||
|
|
||||||
- Load on Demand: modify `/src/main.js` L7, append `import './core/lazy_use'` code.
|
|
||||||
|
|
||||||
- Customize Theme: `vue.config.js`
|
|
||||||
eg:
|
eg:
|
||||||
```ecmascript 6
|
```ecmascript 6
|
||||||
css: {
|
css: {
|
||||||
@ -85,22 +69,36 @@ eg:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Docs
|
### Attributions
|
||||||
|
|
||||||
- [Router and Menu](https://github.com/sendya/ant-design-pro-vue/blob/master/src/router/README.md)
|
- [VueJS](https://vuejs.org/)
|
||||||
- [Table](https://github.com/sendya/ant-design-pro-vue/blob/master/src/components/table/README.md) [@Saraka](https://github.com/saraka-tsukai)
|
- [Ant Design Spec](https://ant.design/docs/spec/introduce)
|
||||||
- [ANTD DefaultConfig](https://github.com/sendya/ant-design-pro-vue/blob/master/src/defaultSettings.js)
|
- [Ant Design Vue](https://vue.ant.design/)
|
||||||
- [Frist page loading animate](https://github.com/sendya/ant-design-pro-vue/blob/master/docs/add-page-loading-animate.md)
|
- [Ant Design Pro Vue](https://github.com/sendya/ant-design-pro-vue) template
|
||||||
- [Multi-Tabs feature/multi-tabs](https://github.com/sendya/ant-design-pro-vue/tree/feature/multi-tabs) [How to remove](https://github.com/sendya/ant-design-pro-vue/blob/master/docs/multi-tabs.md)
|
- [Fontawesome](https://github.com/FortAwesome/vue-fontawesome)
|
||||||
- [LoadOnDemand Demo feature/demand_load](https://github.com/sendya/ant-design-pro-vue/tree/feature/demand_load)
|
- [ViserJS](https://viserjs.github.io/docs.html#/viser/guide/installation)
|
||||||
- [LoadOnDemand Docs](https://github.com/sendya/ant-design-pro-vue/blob/master/docs/load-on-demand.md)
|
- [Icons](https://www.iconfinder.com/iconsets/cat-force) by [Iconka](https://iconka.com/en/downloads/cat-power/)
|
||||||
- [i18n feature/lang](https://github.com/sendya/ant-design-pro-vue/tree/feature/lang) Creator [@musnow](https://github.com/musnow)
|
|
||||||
- [Dependency analysis tool: analyzer](https://github.com/sendya/ant-design-pro-vue/blob/master/docs/webpack-bundle-analyzer.md)
|
### History
|
||||||
- ANTD PRO Components:
|
|
||||||
- Trend [Trend.md](https://github.com/sendya/ant-design-pro-vue/blob/master/src/components/Trend/index.md)
|
The project was created by [Rohit Yadav](rohityadav.cloud) over several weekends
|
||||||
- AvatarList [AvatarList.md](https://github.com/sendya/ant-design-pro-vue/blob/master/src/components/AvatarList/index.md)
|
during late 2018 and early 2019.
|
||||||
- CountDown [CountDown.md](https://github.com/sendya/ant-design-pro-vue/blob/master/src/components/CountDown/index.md)
|
|
||||||
- Ellipsis [Ellipsis.md](https://github.com/sendya/ant-design-pro-vue/blob/master/src/components/Ellipsis/index.md)
|
### License
|
||||||
- NumberInfo [NumberInfo.md](https://github.com/sendya/ant-design-pro-vue/blob/master/src/components/NumberInfo/index.md)
|
|
||||||
- FooterToolbar [FooterToolbar.md](https://github.com/sendya/ant-design-pro-vue/blob/master/src/components/FooterToolbar/index.md)
|
Licensed to the Apache Software Foundation (ASF) under one
|
||||||
- IconSelector [IconSelector.md](https://github.com/sendya/ant-design-pro-vue/blob/master/src/components/IconSelector/README.md) Creator: [@Saraka](https://github.com/saraka-tsukai)
|
or more contributor license agreements. See the NOTICE file
|
||||||
|
distributed with this work for additional information
|
||||||
|
regarding copyright ownership. The ASF licenses this file
|
||||||
|
to you under the Apache License, Version 2.0 (the
|
||||||
|
"License"); you may not use this file except in compliance
|
||||||
|
with the License. You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing,
|
||||||
|
software distributed under the License is distributed on an
|
||||||
|
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||||
|
KIND, either express or implied. See the License for the
|
||||||
|
specific language governing permissions and limitations
|
||||||
|
under the License.
|
||||||
|
|||||||
@ -1,3 +0,0 @@
|
|||||||
Attribution:
|
|
||||||
|
|
||||||
- The icons were taken from https://www.iconfinder.com/iconsets/cat-force
|
|
||||||
Loading…
x
Reference in New Issue
Block a user