# webui-vue

webui-vue is a web-based user interface for the OpenBMC firmware stack built on
[Vue.js](https://vuejs.org/).

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

[phosphor-webui](https://github.com/openbmc/phosphor-webui) was built on
AngularJS and [AngularJS goes End of Life](https://www.convective.com/angularjs-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](CONTRIBUTING.md) for more on how to contribute code,
review some code in
[Gerrit](https://gerrit.openbmc-project.xyz/q/project:openbmc%252Fwebui-vue+status:open),
or join us in the
[GUI design workgroup meeting](https://github.com/openbmc/openbmc/wiki/GUI-Design-work-group).

## Project setup

### Install Dependencies
```
npm install
```
### Create a .env file
1. Create the following file in the root directory
     - .env.development.local
1. Add the following environment variable
    - BASE_URL="https://<BMC IP address or FQDN>"`


## 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](https://cli.vuejs.org/config/).

## Documentation
The documentation for coding standards and components is located in the `docs` directory. It is created using the [VuePress](https://vuepress.vuejs.org/) static site generator. Information about how to write documentation can be found on the [VuePress website](https://vuepress.vuejs.org/).

### Running Locally
```
Run npm docs:serve
```