Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tommysitu authored and benjih committed Jun 9, 2017
1 parent 3cf6856 commit 03557c5
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
# Hoverfly UI

[![Join the chat at https://gitter.im/SpectoLabs/hoverfly](https://badges.gitter.im/SpectoLabs/hoverfly.svg)](https://gitter.im/SpectoLabs/hoverfly?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![CircleCI](https://circleci.com/gh/SpectoLabs/hoverfly-java.svg?style=shield)](https://circleci.com/gh/SpectoLabs/hoverfly-java) [![Join the chat at https://gitter.im/SpectoLabs/hoverfly](https://badges.gitter.im/SpectoLabs/hoverfly.svg)](https://gitter.im/SpectoLabs/hoverfly?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

Hoverfly UI is the Angular 4 frontend application that is bundled with [Hoverfly](https://github.com/SpectoLabs/hoverfly).

## Getting started
## Prerequisites
The project is generated by [Angular CLI](https://github.com/angular/angular-cli) v1.1.0, which requires Node 6.9.0 or higher, and NPM 3 or higher.
You also need [Hoverfly](https://github.com/SpectoLabs/hoverfly) v0.12.0 or higher which can enable developer mode.

To develop this application, you will need to run Hoverfly in developer mode. This is to enable Cross Origin Resource Sharing headers, which will enable the Hoverfly UI to successfully communicate with Hoverfly across ports.
## Getting started
Install dependencies with npm:
```
$ npm install
```
Then run Hoverfly in developer mode. This is to enable Cross Origin Resource Sharing headers, which will enable the Hoverfly UI to successfully communicate with Hoverfly across ports.

```
hoverfly -dev
$ hoverfly -dev
```

## Development server
Expand All @@ -27,4 +34,4 @@ Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.
## Running end-to-end tests

Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
Before running the tests make sure you are serving the app via `ng serve`.
Before running the tests make sure you are serving the app via `ng serve`.

0 comments on commit 03557c5

Please sign in to comment.