diff options
| author | Derick Montague <derick.montague@ibm.com> | 2020-05-28 01:42:48 +0300 |
|---|---|---|
| committer | Derick Montague <derick.montague@ibm.com> | 2020-06-02 21:10:54 +0300 |
| commit | dc80f198bebeedc1b0bc325189e68ff4617f7881 (patch) | |
| tree | 8251d6aad90a86c73b8129913de7b74d911b728c /README.md | |
| parent | bf2131f8a55459f2d9c980856107f0a96009a05a (diff) | |
| download | webui-vue-dc80f198bebeedc1b0bc325189e68ff4617f7881.tar.xz | |
Update contributing file
- Move setup information from readme to contributing file
- Add information about participating in user research
- Explain the design reviews and help wanted projects
- Explain how to ask questions, submit bugs and add new feature requests
- Add link to OpenBMC code of conduct
- Explain how to submit code for review
Signed-off-by: Derick Montague <derick.montague@ibm.com>
Change-Id: Ia2f5a59329e52bcc44a0f48bef8bbf0d97270eba
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 56 |
1 files changed, 4 insertions, 52 deletions
@@ -28,58 +28,10 @@ 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) +- Join us in the [GUI design workgroup meeting](https://github.com/openbmc/openbmc/wiki/GUI-Design-work-group). -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 -``` +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/).
\ No newline at end of file |