Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / webui-vue / 0f22907a4163d6cb84c1cb7c024b09db888e88b2
commit0f22907a4163d6cb84c1cb7c024b09db888e88b2[log] [tgz]
authorSukanya Pandey <sukapan1@in.ibm.com>Fri Nov 27 13:59:30 2020 +0530
committerSukanya Pandey <sukapan1@in.ibm.com>Wed Dec 16 20:13:25 2020 +0530
tree9c49e88e89a3bbaeccbdc492c3b7150b1e49cdb7
parentc5c2ae99f6e9b91526ea5896b3029ab8a7480c6f [diff]
Add form file documentation

Signed-off-by: Sukanya Pandey <sukapan1@in.ibm.com>
Change-Id: I578ead17e5870ae0981aba775c258b49d697a208
3 files changed
tree: 9c49e88e89a3bbaeccbdc492c3b7150b1e49cdb7
  1. .github/
  2. docs/
  3. public/
  4. src/
  5. tests/
  6. .browserslistrc
  7. .env.ibm
  8. .env.intel
  9. .eslintrc.js
  10. .gitignore
  11. .npmrc
  12. babel.config.js
  13. CONTRIBUTING.md
  14. format-code.sh
  15. jest.config.js
  16. LICENSE
  17. MAINTAINERS
  18. package-lock.json
  19. package.json
  20. postcss.config.js
  21. README.md
  22. 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, this repository is its replacement.

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

Several, mostly minor, features remain for feature parity. See GitHub Issues label:phosphor-webui-feature-parity for the complete list.

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.

Should I switch to webui-vue from phosphor-webui?

That is up to you. Several companies have switched.

webui-vue although still missing a few features that were in phosphor-webui, as mentioned above, has the following additional features:

  • Ability to easily theme to meet brand guidelines
  • Accessibility
  • Full Redfish
  • Improved user experience based on user feedback
  • Language translation-ready
  • Modern front-end framework with an active community and future development roadmap

How can I get involved?

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.