openbmc/webui-vue/README.md

1 # webui-vue
3 webui-vue is a web-based user interface for the OpenBMC firmware stack built on
6 ## Hold on... What happened to phosphor-webui?
8 [phosphor-webui](https://github.com/openbmc/phosphor-webui) was built on
10 [AngularJS went End of Life](https://www.convective.com/angularjs-end-of-life/)
13 ## When will this new Vue.js application reach feature parity with phosphor-webui?
16 …s label:phosphor-webui-feature-parity](https://github.com/openbmc/webui-vue/issues?q=is%3Aissue+is…
19 ## What improvements does webui-vue have?
21 As mentioned, this application is built using Vue.js, a modern open-source
22 Model-View-ViewModel JavaScript framework supported by an active community and
25 front-end development best practices and does not suffer from some of the
26 anti-patterns that exist in phosphor-webui today.
28 ## Should I switch to webui-vue from phosphor-webui?
30 It is recommended you switch from phosphor-webui if you haven't already.
32 - [Commit moving several systems to webui-vue](https://github.com/openbmc/openbmc/commit/4a3fa4d6d8…
33 - [Discussion about webui-vue being the standard](https://lists.ozlabs.org/pipermail/openbmc/2020-S…
35 webui-vue has the following additional features:
37 - Ability to easily theme to meet brand guidelines
38 - Accessibility
39 - Full Redfish
40 - Improved user experience based on user feedback
41 - Language translation-ready
42 - Modern front-end framework with an active community and future development
47 - Visit the [CONTRIBUTING.md](CONTRIBUTING.md) for more on how to contribute
49 - Review some code in
50   [Gerrit](https://gerrit.openbmc-project.xyz/q/project:openbmc%252Fwebui-vue+status:open)
51 - Join us in the
52   [GUI design workgroup meeting](https://github.com/openbmc/openbmc/wiki/GUI-Design-work-group).
56 The documentation for coding standards and components is located in the `docs`