hpi-schuelerklub/workshop-portal

# workshop-portal
 
A Ruby on Rails app to manage workshops
 
| Branch     | Travis CI                   | Code Analysis                                                    | Heroku Deploy         | 
| ---------- | --------------------------- | ---------------------------------------------------------------- | --------------------- | 
| production | [![Build Status][tsp]][tup] | [![Coverage Status][covsp]][covup]                               | [![Heroku][hsp]][hup] |
| dev        | [![Build Status][tsd]][tud] | [![Coverage Status][covsd]][covud] [![Code Climate][ccsd]][ccud] | [![Heroku][hsp]][hud] |
 
<!-- There is no way to specify a branch directly, see https://github.com/travis-ci/travis-ci/issues/1996 -->
[tup]: https://travis-ci.org/hpi-schuelerklub/workshop-portal/branches
[tud]: https://travis-ci.org/hpi-schuelerklub/workshop-portal/branches
[tsp]: https://travis-ci.org/hpi-schuelerklub/workshop-portal.svg?branch=production
[tsd]: https://travis-ci.org/hpi-schuelerklub/workshop-portal.svg?branch=dev
 
[covup]: https://coveralls.io/github/hpi-schuelerklub/workshop-portal?branch=production
[covud]: https://coveralls.io/github/hpi-schuelerklub/workshop-portal?branch=dev
[covsp]: https://coveralls.io/repos/github/hpi-schuelerklub/workshop-portal/badge.svg?branch=production
[covsd]: https://coveralls.io/repos/github/hpi-schuelerklub/workshop-portal/badge.svg?branch=dev
 
[ccud]: https://codeclimate.com/github/hpi-schuelerklub/workshop-portal/issues
[ccsd]: https://codeclimate.com/github/hpi-schuelerklub/workshop-portal/badges/gpa.svg
 
[hup]: http://workshopportal.herokuapp.com/
[hud]: http://workshopportal-dev.herokuapp.com/
[hsp]: https://heroku-badge.herokuapp.com/?app=workshopportal&svg=1
[hsd]: https://heroku-badge.herokuapp.com/?app=workshopportal-dev&svg=1
 
 
When all tests succeed on Travis CI, the application is deployed to Heroku. Click the badges for detailed info.
 
## Local Setup
 
* `bundle install` Install the required Ruby gem dependencies defined in the [Gemfile](https://github.com/hpi-schuelerklub/workshop-portal/blob/production/Gemfile)
* `cp database.sqlite.yml database.yml` Select database config (for development we recommend SQLite) 
* `rake db:create db:migrate db:seed` Setup database, run migrations, seed the database with defaults
* `rails s` Start the Rails development server (By default runs on _localhost:3000_)
* `rspec` Run all the tests (using the [RSpec](http://rspec.info/) test framework)
 
## Setup using Vagrant (Virtual Machine)
 
If you want to use a VM to setup the project (e.g. when on Windows), we recommend [Vagrant](https://www.vagrantup.com/).
Please keep in mind that this method may lead to a loss in performance, due to the added abstraction layer.
 
```
vagrant up # bring up the VM
vagrant ssh # login using SSH
bundle install # install dependencies
rbenv rehash # reload newly installed binaries
rails s -b 0 # start the rails server
# the -b part is necessary since the app is running in a VM and would
# otherwise drop the requests coming from the host OS
```
 
## Important Development Commands
* `bundle exec <command>` Run command within the context of the current gemset
* `rspec spec/controller/expenses_controller_spec.rb` Specify a folder or test file to run
* `rails c` Run the Rails console
* `rails c --sandbox` Test out some code without changing any data
* `rails g migration DoSomething` Create migration _db/migrate/*_DoSomething.rb_.
* `rails dbconsole` Starts the CLI of the database you're using
* `rake routes` Show all the routes (and their names) of the application
* `rails assets:precompile` Precompile the assets in app/assets to public/assets
* `rake about` Show stats on current Rails installation, including version numbers
* `rspec --profile` examine how much time individual tests take