Bankai

This gem is inspired by Suspenders for 5xRuby to bootstrap a rails project.

Installation

First, install bankai

gem install bankai

The bootstrap your rails project

bankai projectname

Requirement

• ~> 0.13 required rails >= 7.0
• <= 0.12 required rails >= 5.2

Gemfile

• Oj

Development

• Brakeman
• Bundler Audit
• Rubocop
• Rack Mini Profiler - Enable with RACK_MINI_PROFILER=1
• Annotate
• Bullet
• Dotenv
• Letter Opener
• Overcommit
• Pry Rails

Test

• Capybara
• Google Chromedriver
• Factory Bot
• Faker
• Rspec
• Shoulda Matchers
• Simplecov - Enable with COVERAGE=1

Others

• Configured .gitlab-ci.yml
• Auto filled capistrano configure

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Test Gem

If you want to test the changes for generator is works well, you can add --path options to use your local version

bankai projectname --path=YOUR_LOCAL_GEM_PATH

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/5xRuby/bankai. 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.

Code of Conduct

Everyone interacting in the Bankai project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.