Skip to content

Commit

Permalink
Update README.markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
lilliealbert committed Mar 27, 2013
1 parent aef043f commit 6af3302
Showing 1 changed file with 16 additions and 19 deletions.
35 changes: 16 additions & 19 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,36 +1,31 @@
# Bridge Troll


[![Build Status](https://secure.travis-ci.org/railsbridge/bridge_troll.png)](http://travis-ci.org/railsbridge/bridge_troll)


This is a Rails app that helps RailsBridge workshop organizers plan their events. We also use it as a teaching tool and an open-source community testbed.


The feature set is currently pretty minimal - definitely *pre-alpha*. Eventually, we'd like to fill out the organizer feature set, initially for volunteers to sign up and help organizers know who is coming and what they can do, later to incorporate ways for organizers follow up with students and volunteers.

Bridge Troll is a Rails app that helps RailsBridge workshop organizers plan their events. Right now it allows organizers to create events and volunteers to RSVP to them. Next step is adding student RSVPs and class sorting logic. We have something of a roadmap [here](https://github.com/railsbridge/bridge_troll/wiki/Roadmap).

* [The running app](http://bridgetroll.herokuapp.com/)
* [The staging server](http://bridgetroll-staging.herokuapp.com/)
* [Continuous integration on travis-ci.org](http://travis-ci.org/railsbridge/bridge_troll)
* [Bugs](http://github.com/railsbridge/bridge_troll/issues)

New? Keep reading this, and then head to the wiki to read the [contributor guidelines](https://github.com/railsbridge/bridge_troll/wiki/Contributor-Guidelines).

## Features & Bugs
* New features are in our [Pivotal Tracker project](https://www.pivotaltracker.com/projects/608983).
* Bugs are in [GitHub Issues](https://github.com/railsbridge/bridge_troll/issues?state=open).

## The App
* The real live production application lives at [bridgetroll.herokuapp.com](http://bridgetroll.herokuapp.com/)
* The staging server lives at [bridgetroll-staging.herokuapp.com](http://bridgetroll-staging.herokuapp.com/)
* The continuous integration server is at [travis-ci.org/railsbridge/bridge_troll](http://travis-ci.org/railsbridge/bridge_troll)

## Want to help out?
Join the [google group](https://groups.google.com/forum/?fromgroups#!forum/bridge-troll) and send a quick note introducing yourself.


Please join the [google group](https://groups.google.com/forum/?fromgroups#!forum/bridge-troll) and send a quick note introducing yourself.

Then, have a look at our [feature backlog](https://www.pivotaltracker.com/projects/608983). Pick a feature to work on, fork the project, code some code, and send a [really good pull request](http://railsbridge.github.com/bridge_troll/). Not sure what to do? Ask the [google group](https://groups.google.com/forum/?fromgroups#!forum/bridge-troll) for advice!

Then, have a look at our [feature backlog](https://www.pivotaltracker.com/projects/608983). Pick an issue to work on, fork the project, and then make your changes and send a pull request.


## Setting up for development


You'll need [rvm](http://rvm.beginrescueend.com). The `.rvmrc` file should help make sure you are using the right Ruby version.


## Quickstart

Note: change `git clone` below to be *your* repo.
Expand All @@ -42,7 +37,7 @@ script/bootstrap
rails s
```

Go to http://localhost:3000/ and you can play with the app.
Go to http://localhost:3000/ and you can play with the app. (Pro-tip: to create a valid user without setting up email, run User.last.confirm! in the Rails console after signing up.)

## Running tests

Expand All @@ -57,3 +52,5 @@ Then you can run tests by doing
script/test
```

## Contributors
Literally one billion thanks to our [super awesome contributors](https://github.com/railsbridge/bridge_troll/contributors).

0 comments on commit 6af3302

Please sign in to comment.