Skip to content

Commit

Permalink
Edited homepage and README.
Browse files Browse the repository at this point in the history
  • Loading branch information
andyt committed May 20, 2012
1 parent 33d23bd commit 57a9b86
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.rdoc
Expand Up @@ -5,6 +5,46 @@ This Rails 3.2 application asks a UK voter their constituency and asks them thei
The application then displays results for any chosen constituency, and for the nation as a whole.


== Dependencies

* Ruby 1.9. This has been tested using Ruby 1.9.2-p290. There's a .rvmrc file in the root.
* MongoDB running on localhost (or edit config/mongoid.yml).


== Getting started

Clone the app:

git clone ......

Install gems:

bundle install

Edit config/mongoid.yml if necessary, and seed the database:

rake db:seed

Run the server:

rails s

Connect to localhost in a browser.

http://localhost:3000

If you'd like to poke around the seed data, RailsAdmin is mounted on /admin (user admin@example.com, password 'password'):

http://localhost:3000/admin


== Running the tests

Test coverage is limited to basic association tests on the models.

rspec spec/models/*.rb


== Technical notes

The application skeleton was created using the template specified below:
Expand Down
1 change: 1 addition & 0 deletions app/views/home/index.html.erb
Expand Up @@ -20,6 +20,7 @@

<ul>
<li>Specs are examples only really - the test coverage is minimal. I'd want specs in for all controller actions, and a couple of integration tests too.</li>
<li>Nationwide results don't count seats - just share of vote.</li>
<li>I've spent about 5.5 hours in this, including wrappping it all up, checking it in and doing this homepage.</li>
</ul>

Expand Down

0 comments on commit 57a9b86

Please sign in to comment.