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