xref: /openbmc/webui-vue/README.md (revision d388a28b)
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, so this repository is hopefully its replacement. At this time,
11phosphor-webui still contains more features and you should consider using it.
12
13## When will this new Vue.js application reach feature parity with phosphor-webui?
14
15The current plan is by the end of June 2020, with exception to the following pages:
16- Firmware
17- SNMP settings
18- KVM
19- Virtual media
20
21## Why will this application be better?
22
23As mentioned, this application is built using Vue.js, a modern open-source
24Model-View-ViewModel JavaScript framework supported by an active community and
25strong documentation. It has been architected to allow organizations to easily
26update the theme to support their brand. This rewrite takes advantage of
27front-end development best practices and does not suffer from some of the
28anti-patterns that exist in phosphor-webui today.
29
30## How can I get involved?
31- Visit the [CONTRIBUTING.md](CONTRIBUTING.md) for more on how to contribute code
32- Review some code in [Gerrit](https://gerrit.openbmc-project.xyz/q/project:openbmc%252Fwebui-vue+status:open)
33- Join us in the [GUI design workgroup meeting](https://github.com/openbmc/openbmc/wiki/GUI-Design-work-group).
34
35
36## Documentation
37The 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/).