xref: /openbmc/webui-vue/README.md (revision 511650a9)
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 went End of Life](https://www.convective.com/angularjs-end-of-life/)
11on June 30, 2021. This repository is its replacement.
12
13## When will this new Vue.js application reach feature parity with phosphor-webui?
14
15A few, 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## What improvements does webui-vue have?
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
30It is recommended you switch from phosphor-webui if you haven't already.
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 has the following additional features:
36
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
43  roadmap
44
45## How can I get involved?
46
47- Visit the [CONTRIBUTING.md](CONTRIBUTING.md) for more on how to contribute
48  code
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).
53
54## Documentation
55
56The documentation for coding standards and components is located in the `docs`
57directory. It is created using the [VuePress](https://vuepress.vuejs.org/)
58static site generator. Information about how to write documentation can be found
59on the [VuePress website](https://vuepress.vuejs.org/).
60