Skip to content

Latest commit

 

History

History
88 lines (51 loc) · 3.04 KB

README.md

File metadata and controls

88 lines (51 loc) · 3.04 KB
Raw

Mecha

Gem Version Build Status Code Climate Test Coverage

Mecha generates Rails apps with the defaults used in Magrathea Labs projects.

Installation

Install the mecha gem:

gem install mecha

Usage

mecha <projectname> --devise --bitbucket-pipelines --sentry

This will create a Rails app with name <projectname> and add all our defaults. It configures the app to use sass, remove Turbolinks and CoffeeScript, configure Guard, Rubocop and Simplecov. Also, installs Factory Girl, Faker, Timecop, Capybara, Poltergeist, Database Rewinder.

Available Generators

Danger

--danger installs and add config for Danger. If SimpleCov is installed danger-simplecov_json gem is also installed.

Devise

--devise installs Devise, generates User, i18n files and the internationalized views for English and Brazilian Portuguese.

Bitbucket Pipelines

--bitbucket-pipelines generates the bitbucket-pipelines.yml and a special database config for it.

Pronto

--pronto installs and add config for Pronto. If SimpleCov is installed pronto-simplecov gem is also installed.

RSpec

--rspec installs RSpec and adds configs for tests.

Sentry

--sentry installs Sentry and adds configs to application.rb and application_controller.rb. Remember to create an environment variable with you DSN key. ENV['DNS'].

Simplecov

--simplecov installs Simplecov and adds configs to test/test_helper.rb.

Development

Run rake test or simply just rake to run tests.

To install Mecha in your local environment run:

rake install

Contributing

Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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

Thanks

This project is based on suspenders from thoughtbot.

About Magrathea Labs

Mecha is maintained by Magrathea Labs. The names and logos for Magrathea Labs are trademarks of Magrathea Labs.

Magrathea Labs is a team of specialists in Software Engineering, Distributed Systems, Artificial Intelligence and Data Science. We love to solve challenging problems and build amazing things. Want to do something amazing with us? We are available for hire.