Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Simple microblogging network based on the ostatus protocol.
Ruby JavaScript CoffeeScript
branch: kill_users

This branch is even with hotsh:kill_users

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
app
config
db
doc
lib
log
public
script
test
vendor
.gitignore
.rvmrc
.travis.yml
Gemfile
Gemfile.lock
LICENSE
README.md
Rakefile
config.ru

README.md

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

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

Build Status

Helping out with rstat.us

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
        • If you think it doesn't need a test, make your case, I'm just saying.

Source code documentation

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

Setting up a dev 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:9292/ in your browser, and you'll be good.

To run the tests you may want to make use of bundle exec so you don't get mixed up with different versions of gems that might or might not work with the current rstat.us branch.

Run the tests:

$ bundle exec rake test:all

Running your own node

If you need help with this, then you're not ready to run one. We're working on making this super easy, but right now, we're not quite there.

If you do run your own node, please keep current with upstream.

Something went wrong with that request. Please try again.