xref: /openbmc/webui-vue/README.md (revision 82a346b0)
1# webui-vue
2
3webui-vue is a web-based user interface for the OpenBMC firmware stack built on
4[Vue.js](https://vuejs.org/).
5
6## Hold on... What happened to phosphor-webui?
7
8[phosphor-webui](https://github.com/openbmc/phosphor-webui) was built on
9AngularJS and [AngularJS goes End of Life](https://www.convective.com/angularjs-end-of-life/)
10June 30, 2021, this repository is its replacement.
11
12## When will this new Vue.js application reach feature parity with phosphor-webui?
13
14Several, mostly minor, features remain for feature parity. See [GitHub Issues label:phosphor-webui-feature-parity](
15https://github.com/openbmc/webui-vue/issues?q=is%3Aissue+is%3Aopen+label%3Aphosphor-webui-feature-parity)
16for the complete list.
17
18## Why will this application be better?
19
20As mentioned, this application is built using Vue.js, a modern open-source
21Model-View-ViewModel JavaScript framework supported by an active community and
22strong documentation. It has been architected to allow organizations to easily
23update the theme to support their brand. This rewrite takes advantage of
24front-end development best practices and does not suffer from some of the
25anti-patterns that exist in phosphor-webui today.
26
27## Should I switch to webui-vue from phosphor-webui?
28
29That is up to you. Several companies have switched.
30- [Commit moving several systems to webui-vue](https://github.com/openbmc/openbmc/commit/4a3fa4d6d865b46ba54f2652c82f58a406455ebc)
31- [Discussion about webui-vue being the standard](https://lists.ozlabs.org/pipermail/openbmc/2020-September/023160.html)
32
33webui-vue although still missing a few features that were in
34phosphor-webui, as mentioned above, has the following additional features:
35- Ability to easily theme to meet brand guidelines
36- Accessibility
37- Full Redfish
38- Improved user experience based on user feedback
39- Language translation-ready
40- Modern front-end framework with an active community and future development
41roadmap
42
43## How can I get involved?
44- Visit the [CONTRIBUTING.md](CONTRIBUTING.md) for more on how to contribute code
45- Review some code in [Gerrit](https://gerrit.openbmc-project.xyz/q/project:openbmc%252Fwebui-vue+status:open)
46- Join us in the [GUI design workgroup meeting](https://github.com/openbmc/openbmc/wiki/GUI-Design-work-group).
47
48
49## Documentation
50The documentation for coding standards and components is located in the `docs` directory. It is created using the [VuePress](https://vuepress.vuejs.org/) static site generator. Information about how to write documentation can be found on the [VuePress website](https://vuepress.vuejs.org/).
51