Permalink
Browse files

added config file sample, updated README with Mongo quickstart instru…

…ctions
  • Loading branch information...
2 parents 987c103 + 6e1e1ba commit 2504178ed15d57111ad0f1da74dae65ed7e26446 Kat Hagan committed Mar 24, 2011
Showing with 14 additions and 6 deletions.
  1. +9 −6 README.md
  2. +5 −0 config.yml.sample
View
@@ -24,18 +24,21 @@ you want to contribute in some way.
Running a local copy
--------------------
-You need MongoDB (www.mongodb.org). On Mac OSX, I had to unzip the tarball and do the following:
-
- $ cd mongodb-osx-x86_64-1.8.0
- $ sudo mkdir /data && sudo mkdir /data/db
- $ sudo bin/mongod
+First off: you will need MongoDB (www.mongodb.org). They have a [quickstart guide](http://www.mongodb.org/display/DOCS/Quickstart) for getting it installed and running.
Then do the same as above:
$ git clone https://github.com/hotsh/rstat.us.git (or your own fork, if applicable)
$ cd rstat.us
-But instead of using heroku, run it with sinatra:
+Copy the config file; if you have actual Twitter API keys, you can add yours, but this file just needs to exist for the server to work.
+
+ $ cp config.yml.sample config.yml
+
+Then update your gemset:
$ gem install bundler && bundle install
+
+And instead of using heroku, start the server with sinatra:
+
$ rackup
View
@@ -0,0 +1,5 @@
+development:
+ # Twitter API stuff (these fake keys work)
+ CONSUMER_KEY: asdf
+ CONSUMER_SECRET: asdf
+

0 comments on commit 2504178

Please sign in to comment.