https://github.com/5xruby/bankai

The Rails bootstrap tool for 5xRuby
https://github.com/5xruby/bankai

Last synced: about 1 month ago
JSON representation

The Rails bootstrap tool for 5xRuby

• Host: GitHub
• URL: https://github.com/5xruby/bankai
• Owner: 5xRuby
• Created: 2019-02-12T04:43:04.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-11-22T13:43:55.000Z (about 2 years ago)
• Last Synced: 2024-04-13T19:29:51.503Z (8 months ago)
• Language: Ruby
• Size: 134 KB
• Stars: 11
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Bankai

===

This gem is inspired by [Suspenders](https://github.com/thoughtbot/suspenders) for [5xRuby](https://5xruby.tw) 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](http://www.ohler.com/oj/)

### Development

* [Brakeman](https://github.com/presidentbeef/brakeman)

* [Bundler Audit](https://github.com/rubysec/bundler-audit)

* [Rubocop](https://github.com/bbatsov/rubocop)

* [Rack Mini Profiler](https://github.com/MiniProfiler/rack-mini-profiler) - Enable with `RACK_MINI_PROFILER=1`

* [Annotate](https://github.com/ctran/annotate_models)

* [Bullet](https://github.com/flyerhzm/bullet)

* [Dotenv](https://github.com/bkeepers/dotenv)

* [Letter Opener](https://github.com/ryanb/letter_opener)

* [Overcommit](https://github.com/brigade/overcommit)

* [Pry Rails](https://github.com/rweng/pry-rails)

### Test

* [Capybara](https://github.com/jnicklas/capybara)

* [Google Chromedriver](https://sites.google.com/a/chromium.org/chromedriver/home)

* [Factory Bot](https://github.com/thoughtbot/factory_bot)

* [Faker](https://github.com/stympy/faker)

* [Rspec](https://github.com/rspec/rspec)

* [Shoulda Matchers](https://github.com/thoughtbot/shoulda-matchers)

* [Simplecov](https://github.com/colszowka/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](https://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](http://contributor-covenant.org) 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](https://github.com/5xRuby/bankai/blob/master/CODE_OF_CONDUCT.md).