Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / webui-vue / b346406f3aa407869a3c868fb14322fc529673a3
commitb346406f3aa407869a3c868fb14322fc529673a3[log] [tgz]
authorDerick Montague <derick.montague@ibm.com>Thu Mar 26 16:04:24 2020 -0500
committerDerick Montague <derick.montague@ibm.com>Wed Apr 08 09:18:09 2020 -0500
tree4e2db912a4cb92ae0ccb23c5d4b2de7ea430f21c
parent98059c92dfc1b6f30ffbe02f4ae01e7cba30f8e9 [diff]
Add engines object to package.json

- Add node-check-version to be called on serve and build scripts to
warn user that the correct version of node is not running
- Run npm audit fix to resolve 1532 vulnerabilities
- Add .npmrc file that will adds new npm packages as the exact version.
This settings assures that the ^ is not used when adding the package to
the packacge.json file.

This is to assure that we are running the correct version of node
that will not update the package-lock.json file when installing new
packages. We are using lts/erbium version of node that is 12.16.1
allowing any patch version beyond .1.

Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: I564527c4d9a3946f4c7f08338f1d7ec111d9eb20
3 files changed
tree: 4e2db912a4cb92ae0ccb23c5d4b2de7ea430f21c
  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