Getting Started

So, you want to contribute to the Reservations Ruby on Rails app?

Installing Reservations locally

###Prerequisites You'll need the following to run Reservations:

• Ruby 2.1, with Bundler (Help setting up Ruby on Rails)
• a database server (Sqlite, MySQL or any database supported by Rails)
• ImageMagick

###Installing First, checkout a copy of Reservations using git:

cd /your/code/directory
git clone https://github.com/YaleSTC/reservations.git
cd reservations

Rerservations uses Bundler to manage dependencies, so if you don't have it, get it, then install dependencies

gem install bundler
bundle install

You'll need to edit config/database.yml to point to your database, including the correct user and password. See the Rails guide for common database examples.

Then, create the database and run migrations to build the structure:

rake db:create
rake db:migrate

Finally, start the app locally:

rails server

Just point your browser to localhost:3000 to start up your local development instance of Reservations.

The Reservations team works primarily using Github issues. Head on over to the reservations issues page and look for something you want to work on. (Or, if you have a feature idea/unknown bug, open a new issue!). Before you go ahead and make a new branch, be sure to check out the project naming conventions.

Now that you've got a fresh branch named after your issue, get coding!

You can find more useful developer resources in the sidebar ->