Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / webui-vue / 0a3405f78a7ad0846c038d9b0ebe3a09b0c21579
commit0a3405f78a7ad0846c038d9b0ebe3a09b0c21579[log] [tgz]
authorDerick Montague <derick.montague@ibm.com>Fri Feb 07 23:10:59 2020 -0600
committerDerick Montague <derick.montague@ibm.com>Wed Feb 12 17:26:16 2020 +0000
tree3a02ce1a35975a7714510da89284a45625ca5b65
parent7fc4cd7dbe2f9eb38bb876aa4febf8f5e13a279f [diff]
Update README.md

- Fix docs script typo
- Add .env file info
- Update section level header hierarchy

Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: I0f060b89913d516f93df36c75fe3e912ea08b4bd
1 file changed
tree: 3a02ce1a35975a7714510da89284a45625ca5b65
  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