re-rails

re-rails is a customized version of {Suspenders}[https://github.com/thoughtbot/suspenders]the base Rails application used at thoughtbot.

Installation

From Ruby-Gems

First install the re-rails gem:

gem install re-rails

Then run:

re-rails projectname

This will create a Rails 4.0 app in projectname.

By default this script creates a new git repository. See below if you want to use it against an existing repo.

From Source

First Clone the repo

  git clone git@github.com:re-analytics/re-rails.git

or

  hub clone re-analytics/re-rails

then cd into the directory and run rake build

Gemfile

To see the latest and greatest gems, look at re-rails’ templates/Gemfile_clean, which will be appended to the default generated projectname/Gemfile.

It includes application gems like:

And testing gems like:

Other goodies

re-rails also comes with:

re-rails fixes several of Rails’ insecure defaults:

Heroku

You can optionally create Heroku staging and production apps:

re-rails app --heroku true

This:

Git

This will initialize a new git repository for your Rails app. You can bypass this with the --skip-git option:

re-rails app --skip-git true

GitHub

You can optionally create a GitHub repository for the suspended Rails app. It requires that you have Hub on your system:

curl http://hub.github.com/standalone -sLo ~/bin/hub && chmod +x ~/bin/hub
re-rails app --github organization/project

This has the same effect as running:

hub create organization/project

Dependencies

re-rails requires Ruby 1.9.2 or greater.

Some gems included in re-rails have native extensions. You should have GCC installed on your machine before generating an app with re-rails.

Use OS X GCC Installer for Snow Leopard (OS X 10.6).

Use Command Line Tools for XCode for Lion (OS X 10.7) or Mountain Lion (OS X 10.8).

We use Capybara Webkit for full-stack Javascript integration testing. It requires QT. Instructions for installing QT are here.

PostgreSQL needs to be installed and running for the db:create rake task.

Issues

If you have problems, please create a Github Issue.

Contributing

Please see CONTRIBUTING.md for details.

Credits

re-rails is based off Suspenders which is maintained and funded by thoughtbot, inc.

The names and logos for thoughtbot are trademarks of thoughtbot, inc.

License

Licensed Under MIT