Add some more detail to the README pre-adding a CONTRIBUTING

This commit is contained in:
John Cowen 2018-07-05 09:20:58 +01:00
parent 690225990b
commit b2f1436998
1 changed files with 10 additions and 20 deletions

View File

@ -13,37 +13,27 @@ You will need the following things properly installed on your computer.
## Installation
* `git clone <repository-url>` this repository
* `cd ui`
* `git clone https://github.com/hashicorp/consul.git` this repository
* `cd ui-v2`
* `yarn install`
## Running / Development
* `yarn run start`
* `make start-api` or `yarn start:api` (this starts a Consul API double running
on http://localhost:3000)
* `make start` or `yarn start` to start the ember app that connects to the
above API double
* Visit your app at [http://localhost:4200](http://localhost:4200).
* Visit your tests at [http://localhost:4200/tests](http://localhost:4200/tests).
### Code Generators
Make use of the many generators for code, try `ember help generate` for more details
### Running Tests
* `ember test`
* `ember test --server`
You do not need to run `make start-api`/`yarn run start:api` to run the tests
### Building
* `ember build` (development)
* `ember build --environment production` (production)
### Deploying
## Further Reading / Useful Links
* [ember.js](https://emberjs.com/)
* [ember-cli](https://ember-cli.com/)
* Development Browser Extensions
* [ember inspector for chrome](https://chrome.google.com/webstore/detail/ember-inspector/bmdblncegkenkacieihfhpjfppoconhi)
* [ember inspector for firefox](https://addons.mozilla.org/en-US/firefox/addon/ember-inspector/)
* `make test` or `yarn run test`
* `make test-view` or `yarn run test:view` to view the tests running in Chrome