.            .
 .___    ____ _/_     ___  _/_     ,   .   ____
 /   \  (      |     /   `  |      |   |  (
 |   '  `--.   |    |    |  |      |   |  `--.
 /     \___.'  \__/ `.__/|  \__/ / `._/| \___.'

rstat.us is a microblogging site built on top of the ostatus protocol.

(reason for existing)

Helping out with rstat.us

We would love your help!

• For questions, join the mailing list or IRC
• Issue filing instructions
• Documentation addition instructions
• How to get started

If you'd like to contribute, here are some details:

• The stack: ruby/rails 3.1/mongodb
• The code
• The documentation (need lots of improvement here!)
• The Issues list
• We follow GitHub flow, as a workflow. Basically:
  • Please fork the project and make a pull request
    • Pull requests will not be merged without tests/documentation
      • We use minitest/capybara for tests
      • We use docco (rocco) for documentation

Source code documentation

We have documentation that explains all of our source code, using rocco. You can view it here.

Setting up a development environment

First off: you will need MongoDB (www.mongodb.org). They have a quickstart guide for getting it installed and running.

Then do:

$ git clone https://github.com/$MY_GITHUB_USERNAME/rstat.us.git
$ cd rstat.us

Then update your gemset:

$ gem install bundler && bundle install

And start the server:

$ rails server

Bam! Visit http://localhost:3000/ in your browser, and you should see your development version of rstat.us!

To run the tests:

$ bundle exec rake test

Running your own node

We're working on making this super easy, but right now we're not quite there.