Armadura

Armadura is a gem that lets you generate a Rails application, preconfigured with sensible defaults.

Installation

First install the armadura gem:

gem install armadura

Then run:

armadura projectname

This will create a Rails app in projectname using the latest version of Rails.

Associated services

Gemfile

To see the latest and greatest gems, look at Armadura's Gemfile, which will be appended to the default generated projectname/Gemfile.

It includes application gems like:

And development gems like:

And testing gems like:

Other goodies

Armadura also comes with:

Heroku

You can optionally create Heroku staging and production apps:

armadura app --heroku true

This:

You can optionally specify alternate Heroku flags:

armadura app \
  --heroku true \
  --heroku-flags "--region eu --addons sendgrid,ssl"

See all possible Heroku flags:

heroku help create

Git

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

armadura 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
armadura app --github organization/project

This has the same effect as running:

hub create organization/project

Spring

Armadura uses spring by default. It makes Rails applications load faster, but it might introduce confusing issues around stale code not being refreshed. If you think your application is running old code, run spring stop. And if you'd rather not use spring, add DISABLE_SPRING=1 to your login file.

Dependencies

Armadura requires the latest version of Ruby.

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

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.

License

Armadura is copyright © 2016 Elliot Winkler. It is adapted from Suspenders, a thoughtbot project. It is free software, and may be redistributed under the terms specified in the LICENSE file.