Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / webui-vue / d0d9215bbb3c5b56d682abffb5abb916ff9d4387
commitd0d9215bbb3c5b56d682abffb5abb916ff9d4387[log] [tgz]
authorDerick Montague <derick.montague@ibm.com>Wed Apr 08 13:31:31 2020 -0500
committerDerick Montague <derick.montague@ibm.com>Thu Apr 09 14:21:52 2020 +0000
treececa912fd742f17bc4b9ff031aaa807249818f41
parent6859203cebe3b6a31d23d55a3555bf36d6c73242 [diff]
Fix documentation error

Using SCSS tokens in single file components results in a compile issue
causing the documentation to white screen. Moving custom alert styles
to the global alert .scss file to resolve this issue and to keep all
alert styles in one place.

Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: I047fa15c76cdfb842e5c00eea99e529595b94632
2 files changed
tree: ceca912fd742f17bc4b9ff031aaa807249818f41
  1. .github/
  2. docs/
  3. public/
  4. src/
  5. tests/
  6. .browserslistrc
  7. .eslintrc.js
  8. .gitignore
  9. .npmrc
  10. babel.config.js
  11. CONTRIBUTING.md
  12. LICENSE
  13. MAINTAINERS
  14. package-lock.json
  15. package.json
  16. postcss.config.js
  17. README.md
  18. 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