Railman

Gem Version Build Status Dependency Status Code Climate Coverage Status

Railman generates new rails applications based on a customized template and ready for deployment in production. It can also update existing applications when railman-template changes.

The generated rails application includes:

  • semantic-rails-ui gem with modified scaffolds,
  • .env configuration
  • deployment configuration,
  • sidekiq background jobs and scheduled jobs
  • jenkins scripts
  • test infrastructure for capybara headless webtests

Installation

Add this line to your application's Gemfile:

gem 'railman'

And then execute:

$ bundle

Or install it yourself as:

$ gem install railman

Usage

Run railman new APP_NAME [--public] to create new rails application. Run railman upgrade APP_NAME to upgrade existing rails application.

If you use the public option, a public git repository is created, otherwise a repository will be private (default)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install.

To release a new version, run bundle exec rake release_patch, bundle exec rake release_minor, oder bundle exec rake release_major, which will create a git tag for the version, push git commits and tags, and push the .gem file to https://rubygems.org.

Contributing

Bug reports and pull requests are welcome on github at https://github.com/igorj/railman.

License

The gem is available as open source under the terms of the MIT License.