xref: /openbmc/webui-vue/README.md (revision 0214fedb)
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
14The current plan is by the end of July 2020, with exception to the following pages:
15- Firmware
16- SNMP settings
17- Virtual media
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## How can I get involved?
29- Visit the [CONTRIBUTING.md](CONTRIBUTING.md) for more on how to contribute code
30- Review some code in [Gerrit](https://gerrit.openbmc-project.xyz/q/project:openbmc%252Fwebui-vue+status:open)
31- Join us in the [GUI design workgroup meeting](https://github.com/openbmc/openbmc/wiki/GUI-Design-work-group).
32
33
34## Documentation
35The 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/).
36