55minutes/rails-starter

A simple template for starting new Rails 4 projects.

How this repository is organized

There are two branches of this project that are regularly maintained: master and bootstrap.

• The master branch contains the newest rails-starter template. Most projects are best served by starting from this branch.
• The bootstrap branch contains all the latest code from master, plus extra gems, views, and helpers specific to Twitter Bootstrap. If you are starting a project where you plan to use Twitter Bootstrap, the bootstrap branch is what you need.

About rails-starter

Rails-stater is a project template for Rails 4 projects that is pre-configured for Capistrano-based deployment. This template targets the following server stack:

• Ubuntu 12.04 LTS
• PostgreSQL
• Unicorn
• Nginx
• rbenv
• dotenv
• Postmark for mail delivery

By using this template, you’ll hit the ground running with best practices for productive Rails and front-end development:

• RSpec and Capybara for testing
• guard-livereload for fast, iterative front-end development
• Up-to-date rbenv and bundler gem management techniques
• SMACSS for organizing stylesheets
• Capistrano recipes to make deployment easy
• .env for storing encryption keys and secret tokens safely outside of source control
• An easy way to add Twitter Bootstrap, should you choose to do so (use the bootstrap branch)

More on our blog:

• Rails OS X Developer Guide – Installing an rbenv-based Rails stack on Mountain Lion
• Lightning-Fast Sass Reloading in Rails 3.2
• SMACSS and Rails – A Styleguide for the Asset Pipeline

Getting started

Install rbenv

We recommend rbenv and ruby-build for managing Ruby installations. This template currently uses Ruby 2.1.2.

1. Install rbenv into ~/.rbenv using the fantastic rbenv-installer script.
2. Run rbenv install 2.1.2 (this will take several minutes).
3. Optional: make 2.1.2 your default ruby by running rbenv global 2.1.2.

Install Qt

This starter uses the capybara-webkit gem, which requires the Qt libraries (version 4.8 or higher). These libraries aren't installed out of the box on most systems, including Mac OS X.

To install the Qt libraries, follow these instructions. Homebrew is the easiest option on the Mac.

Create a Rails project from the template

1. Download and extract either the master (plain starter) or the bootstrap (Twitter Bootstrap-themed starter) ZIP archive of the rails-starter repository; this will be the start of your new Rails project.
2. Globally replace rails-starter and RailsStarter with the desired name of your project.
3. cd into the project and run git init && git add . && git commit -m "init" to initialize a git repository.

Bundle the required gems

1. Install bundler: gem install bundler
2. Run rbenv rehash.
3. Run bundle install
4. Once more, run rbenv rehash.

Protip: Install rubygems-bundler so you won’t need to use bundle exec all the time. Don’t forget to reinstall it whenever you install a new version of Ruby.

Set up your local configuration

1. Run cp example.env .env to make a local version of the app settings.
2. Run cp config/database.example.yml config/database.yml to make a local version of the database config.

Create the database

1. Run rake db:create to initialize the database (make sure postgres is started first).
2. Run rake db:migrate.
3. Commit the generated schema: git add db && git commit -m "Create schema with db:migrate"

Run it!

1. Run rake spec to make sure everything works.
2. Run rails s to start the app.

Protip: Install this handy bash script to consolidate rails and rake into a single r shortcut.

Using the provided Capistrano 3.x recipes

This project uses the capistrano-fiftyfive gem, which provides all recipes needed to set up and deploy on Ubuntu 12.04. It's super simple.

Purchase a VPS

Using a provider like DigitalOcean, purchase an Ubuntu 12.04 LTS virtual private server. Make sure to install your SSH key for the root user.

Make note of the IP address of the VPS. Then:

Change the deployment settings of your project

To use capistrano you will need to update the deployment settings to match your VPS.

1. Review the contents of config/deploy.rb. Be sure the change the :repository to match your git repository URL.
2. Update the IP address in config/deploy/staging.rb to match the IP of the VPS you just purchased.
3. By default, cap production deploy will deploy from the master branch, and cap staging deploy will deploy from the development branch. Update the branch settings if you use a different branch policy.

Capistrano takes care of the rest!

Don't forget to git push your code so that capistrano can deploy it. Make sure you've pushed the branch that capistrano is expecting in staging.rb. Then run these commands and follow the prompts to install Nginx, SSL, PostgreSQL, Ruby (the whole stack!):

 cap staging provision
 cap staging deploy:migrate_and_restart

Refer to the capistrano-fiftyfive README more details and deployment instructions.