Permalink
Browse files

Add installation notes

  • Loading branch information...
samoli committed May 22, 2012
1 parent ecfe25b commit d84ea41319a875820ff653b469fb984bfdedfe25
Showing with 27 additions and 2 deletions.
  1. +27 −2 README.markdown
View
@@ -4,13 +4,37 @@ This is an example Rails app that shows how to tag a photo using Shared Workforc
The app has a user model which includes a photo. When a user is created and a photo is uploaded, the photo is sent to Shared Workforce where it is tagged by a human worker.
-The task class is in app/tasks/tag_photo_task.rb, and there is an associated unit test in test/tasks/tag_photo_task_test.rb
+The task class is in `app/tasks/tag_photo_task.rb`, and there is an associated unit test in `test/tasks/tag_photo_task_test.rb`
+
+## Installation
+
+Clone the app to your local workstation:
+
+```term
+ $ git://github.com/sharedworkforce/sharedworkforce-demo-rails.git`
+ Cloning into sharedworkforce-demo-rails...
+```
+
+Run bundle install to install required gems:
+
+```term
+ $ cd sharedworkforce-demo-rails
+ $ bundle install
+ Your bundle is complete!
+```
## Running the demo app
To try this demo app, you will need your own API key from Shared Workforce. To get one, visit http://www.sharedworkforce.com or email erica@sharedworkforce.com.
-Once you have your API key, rename the file .env_template to .env, and add your Shared Workforce API key. You will also need to enter the details of an Amazon S3 bucket to use for the test.
+Once you have your API key, rename the file .env_template to .env, and add your Shared Workforce API key.
+
+```term
+ $ cp .env_template .env
+ $ $EDITOR .env
+```
+
+You will also need to enter the details of an Amazon S3 bucket to use for the test.
```
SHAREDWORKFORCE_API_KEY=my-api-key
@@ -22,6 +46,7 @@ S3_BUCKET=my-s3-bucket
Once you have entered your details, run the app using Foreman:
```term
+ $ rake db:setup
$ foreman start
```

0 comments on commit d84ea41

Please sign in to comment.