Skip to content

Commit

Permalink
Add documentation for how to run as a standalone app
Browse files Browse the repository at this point in the history
  • Loading branch information
tuzz committed Jan 3, 2018
1 parent 1052c22 commit 2c41881
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,27 @@ And then execute:
$ bundle
```

### Running as a standalone app

If you want to work on this gem directly, without having to add it to another
application, you can run it in the development vm:

```
$ cd /var/govuk/govuk-puppet/development-vm
$ bowl publishing-components
```

Then visit [publishing-components.dev.gov.uk](http://publishing-components.dev.gov.uk).

If you don't want to run it in the development vm, you can start the app with:

```
$ gem install foreman
$ PLEK_SERVICE_STATIC_URI=assets.publishing.service.gov.uk foreman start
```

Then visit [localhost:5000](http://localhost:5000).

#### Integration with Heroku

To make the best use of the component guide we use Heroku to serve the current `master` build and whenever a [pull request is added](https://devcenter.heroku.com/articles/github-integration-review-apps)
Expand Down

0 comments on commit 2c41881

Please sign in to comment.