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