From 0a3405f78a7ad0846c038d9b0ebe3a09b0c21579 Mon Sep 17 00:00:00 2001 From: Derick Montague Date: Fri, 7 Feb 2020 23:10:59 -0600 Subject: Update README.md - Fix docs script typo - Add .env file info - Update section level header hierarchy Signed-off-by: Derick Montague Change-Id: I0f060b89913d516f93df36c75fe3e912ea08b4bd --- README.md | 32 ++++++++++++++++++++------------ 1 file changed, 20 insertions(+), 12 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index d8a7a290..3029babd 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,18 @@ 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? +## 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? +## 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? +## 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 @@ -23,7 +23,7 @@ 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? +## How can I get involved? Visit the [CONTRIBUTING.md](CONTRIBUTING.md) for more on how to contribute code, review some code in @@ -31,37 +31,44 @@ review some code in or join us in the [GUI design workgroup meeting](https://github.com/openbmc/openbmc/wiki/GUI-Design-work-group). -### Project setup +## 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://"` -#### Compiles and hot-reloads for development + +## Compiles and hot-reloads for development ``` npm run serve ``` -#### Compiles and minifies for production +## Compiles and minifies for production ``` npm run build ``` -#### Run your unit tests +## Run your unit tests ``` npm run test:unit ``` -#### Lints and fixes files +## Lints and fixes files ``` npm run lint ``` -### Customize configuration +## Customize configuration See [Configuration Reference](https://cli.vuejs.org/config/). @@ -69,5 +76,6 @@ See [Configuration Reference](https://cli.vuejs.org/config/). 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 -1. `Run npm docs:dev` -1. Open browser and go to `http://localost:8080/` +``` +Run npm docs:serve +``` -- cgit v1.2.3