Rails Template

This is a template Rails 4.0.0 application that includes:

• Haml, SimpleForm
• RSpec, Cucumber, factory_girl, Poltergeist, Guard, Spork
• Twitter Bootstrap, Font Awesome
• Unicorn Procfile

If you would also like basic user auth, please see the instructions on the devise branch below.

Development

Requirements

Assuming you're on a *nix system, install RVM (Ruby Version Manager) with:

$ curl -L https://get.rvm.io | bash -s stable --ruby

Then check to see that you have Ruby 2.0.0 or later:

$ ruby --version
ruby 2.0.0p0 (2013-02-24 revision 39474) [x86_64-linux]

# rvm should auto-install Ruby 2.0.0 or greater, if not run:
# $ rvm install 2.0.0

Obtaining and Using the Rails App

First, obtain the code:

# create a directory where your app will live locally
$ mkdir app-name
$ cd app-name

# then clone the git repo into that directory
$ git clone git@github.com:bchase/rails-template.git .
# NOTE: this clones the repo into the working directory 
# with `.` (here, this represents the new `app-name` dir)

# for an app with user auth already started, clone from the the `devise` branch instead
# $ git clone git@github.com:bchase/rails-template.git -b devise .

Next, get rid of the local git repo, create your own, and push:

# get rid of git repo to this point and init a new one
$ rm -rf .git/
$ git init && git add . && git commit -m 'initial commit'

# to add a new remote and push, simply:
# $ git remote add origin [your-git-remote]
# $ git push -u origin master

And finally, get up and running with:

$ bundle install    # install necessary gems
$ rake db:migrate   # set up the database
$ rails server      # start the rails server

If rails server fires up without error, you'll find the Rails app running at http://localhost:3000.

Alternatively, you can run from the Procfile with:

$ foreman start

## Deploying to Heroku

create a heroku account at http://api.heroku.com/signup

install the toolbelt per https://toolbelt.heroku.com/

login

$ heroku login

create a heroku app

$ heroku create [app-name]

deploy

$ git push heroku master

rake the db

$ heroku run rake db:migrate

rails console

$ heroku run console

it's worth noting that the heroku create above will

create an app and a git remote just the same as if you ran:

$ heroku git:remote --app [app-name] --remote heroku

additionally, git push heroku master follows the format:

$ git push [git-remote-name] [branch]

and uses the heroku remote from above

## Checking Available Routes

For a local Rails app:

```bash
$ rake routes

For Heroku:

$ heroku run rake routes

Updating Rails

If your application is running on Heroku, and this update is in regards to a security vulnerability, it's a good idea to activate maintenance mode on production while you work. This can be accomplished with the following:

$ heroku maintenance:on

It's also a good idea to run all your tests before and after updating, so that you can compare the failure numbers and ensure the update did not cause any regressions. Run everything and take note of the numbers for passed/failed/pending:

$ rake cucumber
$ rake rspec

Now open up the Gemfile and change the version string for Rails:

### Gemfile ###

source 'https://rubygems.org'

gem 'rails', '4.0.0' # <= VERSION STRING
# ...

Then update the bundle:

$ bundle update rails

If all goes well, try re-running the tests/specs:

$ rake cucumber
$ rake rspec

Compare the passed/failed/pending counts to those before and adjust as needed.

Once everything works, make a commit, push your changes, and deploy (if applicable):

$ git add .
$ git commit -m 'update rails[, additional information]'

# push to origin
$ git push

# deploy to heroku
$ git push heroku master

Finally, be sure to turn your maintenance message off:

$ heroku maintenance:off