From b2f1436998531bb9a5e18d5f8ecf5ed10e414b4e Mon Sep 17 00:00:00 2001 From: John Cowen Date: Thu, 5 Jul 2018 09:20:58 +0100 Subject: [PATCH] Add some more detail to the README pre-adding a CONTRIBUTING --- ui-v2/README.md | 30 ++++++++++-------------------- 1 file changed, 10 insertions(+), 20 deletions(-) diff --git a/ui-v2/README.md b/ui-v2/README.md index 82092f19a..9e6da2e0d 100644 --- a/ui-v2/README.md +++ b/ui-v2/README.md @@ -13,37 +13,27 @@ You will need the following things properly installed on your computer. ## Installation -* `git clone ` 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