Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / webui-vue / 7223a9fb310ab2f5665b7247d8f24144cbacbede
commit7223a9fb310ab2f5665b7247d8f24144cbacbede[log] [tgz]
authorDerick Montague <derick.montague@ibm.com>Thu Mar 12 21:49:55 2020 +0000
committerDerick Montague <derick.montague@ibm.com>Thu Mar 12 21:49:55 2020 +0000
treef75f2b6cdb1df7f1dc64a421cf60c34e02e7cbe0
parent71650fff20c0ad29eb05d770736386863324b64e [diff]
Revert "Add alert message component and documentation"

This reverts commit 71650fff20c0ad29eb05d770736386863324b64e.

Reason for revert: Found an issue with Sass loader when compiling docs that needs to be addressed.

Change-Id: Icdd1243665f60849bfb341594452687fcdaeebe2
11 files changed
tree: f75f2b6cdb1df7f1dc64a421cf60c34e02e7cbe0
  1. docs/
  2. public/
  3. src/
  4. tests/
  5. .browserslistrc
  6. .eslintrc.js
  7. .gitignore
  8. babel.config.js
  9. CONTRIBUTING.md
  10. jest.config.js
  11. LICENSE
  12. MAINTAINERS
  13. package-lock.json
  14. package.json
  15. postcss.config.js
  16. README.md
  17. 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

Install Dependencies

npm install

Create a .env file

  1. Create the following file in the root directory
    • .env.development.local
  2. Add the following environment variable
    • BASE_URL="https://"`

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

Customize configuration

See Configuration Reference.

Documentation

The documentation for coding standards and components is located in the docs directory. It is created using the VuePress static site generator. Information about how to write documentation can be found on the VuePress website.

Running Locally

Run npm docs:serve