Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / webui-vue / c4844b457cb7eeb8cab0ee8dca179be684a38b17
commitc4844b457cb7eeb8cab0ee8dca179be684a38b17[log] [tgz]
authorGunnar Mills <gmills@us.ibm.com>Tue Jan 28 20:18:40 2020 -0600
committerGunnar Mills <gmills@us.ibm.com>Tue Jan 28 20:19:24 2020 -0600
tree0856ee85b0d0fd9cfc0e647cab40d02fb2bedf13
parentff4ab407dac4b5652bf8b7a096894ba461a6cf6a [diff]
Revert "Change eslint rules to use vue recommended"

Merged accidentally. Although this one did have the proper +1s/+2s.
The 2 underneath did not. The author will resubmit.

This reverts commit 5e7ac49058e5dc37fd43ecf3c0d06f5dda14af5b.

Change-Id: Iceb1de3a170cc0b592b183545c792aa3eb87bfee
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
16 files changed
tree: 0856ee85b0d0fd9cfc0e647cab40d02fb2bedf13
  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