Revert "Add coding guidelines and component documentation"

Merged accidentally. Did not have proper +1s/+2s. The author will
resubmit. Apologies for the noise.

This reverts commit aae4312c3c535253b2d5db7a75503f0237ae423e.

Change-Id: I110dd4e12286836aedf84dfba2c4ef07cac08b46
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
19 files changed
tree: f8d0ff86f77c5c930ec23803b6d7a4ca2e952ecc
  1. public/
  2. src/
  3. tests/
  4. .browserslistrc
  5. .eslintrc.js
  6. .gitignore
  7. babel.config.js
  8. CONTRIBUTING.md
  9. jest.config.js
  10. LICENSE
  11. MAINTAINERS
  12. package-lock.json
  13. package.json
  14. postcss.config.js
  15. README.md
  16. vue.config.js
README.md

webui-vue

webui-vue is a web-based user interface for the OpenBMC firmware stack built on Vue.js.

Hold on... What happened to phosphor-webui?

phosphor-webui was built on AngularJS and AngularJS goes End of Life June 30, 2021, so this repository is hopefully its replacement. At this time, phosphor-webui still contains more features and you should consider using it.

When will this new Vue.js application reach feature parity with phosphor-webui?

The current plan is by June 2020!

Why will this application be better?

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.

How can I get involved?

Visit the CONTRIBUTING.md for more on how to contribute code, review some code in Gerrit, or join us in the GUI design workgroup meeting.

Project setup

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Run your unit tests

npm run test:unit

Lints and fixes files

npm run lint