Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / webui-vue / aae4312c3c535253b2d5db7a75503f0237ae423e
commitaae4312c3c535253b2d5db7a75503f0237ae423e[log] [tgz]
authorDerick Montague <derick.montague@ibm.com>Fri Jan 03 08:36:20 2020 -0600
committerYoshie Muranaka <yoshiemuranaka@gmail.com>Tue Jan 28 14:18:05 2020 -0800
tree83967ba91a1ff7d2f0909ce08029f2c2c7425c68
parent996d2d57be172fd36952ec7d679e411565cac013 [diff]
Add coding guidelines and component documentation

- Add deploy script to create and deploy dist file to gh-pages branch
- Update README to include instructions on documentation development
and deployment
- Update vue and vue-template-compiler to be compatible with vuepress
- Set vue-date-fns to use specific version
- Add shell pages to be completed later

Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: I2fdae06d53c298d45f7a638e8875717a47050dbf
19 files changed
tree: 83967ba91a1ff7d2f0909ce08029f2c2c7425c68
  1. docs/
  2. public/
  3. src/
  4. tests/
  5. .browserslistrc
  6. .eslintrc.js
  7. .gitignore
  8. babel.config.js
  9. CONTRIBUTING.md
  10. deploy-doc.sh
  11. jest.config.js
  12. LICENSE
  13. MAINTAINERS
  14. package-lock.json
  15. package.json
  16. postcss.config.js
  17. README.md
  18. vue.config.js
README.md

webui-vue

webui-vue is a web-based user interface for the OpenBMC firmware stack built on Vue.js.

Hold on... What happened to phosphor-webui?

phosphor-webui was built on AngularJS and AngularJS goes End of Life June 30, 2021, so this repository is hopefully its replacement. At this time, phosphor-webui still contains more features and you should consider using it.

When will this new Vue.js application reach feature parity with phosphor-webui?

The current plan is by June 2020!

Why will this application be better?

As mentioned, this application is built using Vue.js, a modern open-source Model-View-ViewModel JavaScript framework supported by an active community and strong documentation. It has been architected to allow organizations to easily update the theme to support their brand. This rewrite takes advantage of front-end development best practices and does not suffer from some of the anti-patterns that exist in phosphor-webui today.

How can I get involved?

Visit the CONTRIBUTING.md for more on how to contribute code, review some code in Gerrit, or join us in the GUI design workgroup meeting.

Project setup

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Run your unit tests

npm run test:unit

Lints and fixes files

npm run lint

Customize configuration

See Configuration Reference.

Documentation

The documentation for coding standards and components is located in the docs directory. It is created using the VuePress static site generator. Information about how to write documentation can be found on the VuePress website.

Development

  1. Run npm docs:dev
  2. Open browser and go to http://localost:8080/

Deployment

  1. Merge any pull requests
  2. Run ./depoly-docs.sh