Skip to content

Commit

Permalink
Merge pull request #342 from codeforamerica/update-readme
Browse files Browse the repository at this point in the history
Add link to Wiki article for deploying to Heroku
  • Loading branch information
anselmbradford committed Mar 21, 2014
2 parents 371505c + 71cc8f4 commit 892ce83
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,16 @@ You can see a live example for services in San Mateo County here: [http://smc-co

We gladly welcome contributions. Below you will find instructions for installing the project and contributing.

## Stack Overview

* Ruby version 2.0.0
* Rails version 3.2.16
* Template Engines: ERB and HAML
* Testing Frameworks: RSpec, Capybara and PhantomJS (via Poltergeist gem), JasmineJS installed but not currently used (via Teaspoon gem)

## Deploying to Heroku
See the [Wiki](https://github.com/codeforamerica/ohana-web-search/wiki/How-to-deploy-Ohana-Web-Search-to-your-Heroku-account).

## Installation
Please note that the instructions below have only been tested on OS X. If you are running another operating system and run into any issues, feel free to update this README, or open an issue if you are unable to resolve installation issues.

Expand Down Expand Up @@ -47,9 +57,9 @@ By default, the app is configured to point to the demo API at `http://ohanapi.he
### Run the app
Start the app locally using Unicorn:

unicorn
unicorn -p 4000

Ohana SMC should now be running at [http://lvh.me:8080](http://lvh.me:8080)
Ohana SMC should now be running at [http://lvh.me:4000](http://lvh.me:4000)

Please make sure you are using `lvh.me` instead of `localhost` to be able to test the translation feature. Read more about [lvh.me](http://matthewhutchinson.net/2011/1/10/configuring-subdomains-in-development-with-lvhme).

Expand All @@ -73,13 +83,6 @@ For faster tests:

To see the actual tests, browse through the [spec](https://github.com/codeforamerica/ohana-web-search/tree/master/spec) directory.

## Development Details

* Ruby version 2.0.0
* Rails version 3.2.16
* Template Engines: ERB and HAML
* Testing Frameworks: RSpec, Capybara and PhantomJS (via Poltergeist gem), JasmineJS installed but not currently used (via Teaspoon gem)

## Contributing
In the spirit of open source software, **everyone** is encouraged to help improve this project.

Expand Down

0 comments on commit 892ce83

Please sign in to comment.