Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khusnetdinov/kazan
:bomb: Kazan creates rails project and setups predefined gems and tools. Env settings, Spec tools, Database settings, development tools. Bonuses for production.
https://github.com/khusnetdinov/kazan
boilerplate-application kazan kazan-creates-rails rails rails-application rspec ruby
Last synced: 3 months ago
JSON representation
:bomb: Kazan creates rails project and setups predefined gems and tools. Env settings, Spec tools, Database settings, development tools. Bonuses for production.
- Host: GitHub
- URL: https://github.com/khusnetdinov/kazan
- Owner: khusnetdinov
- License: mit
- Created: 2016-10-09T11:16:02.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-06T07:49:38.000Z (9 months ago)
- Last Synced: 2024-04-24T04:31:47.170Z (8 months ago)
- Topics: boilerplate-application, kazan, kazan-creates-rails, rails, rails-application, rspec, ruby
- Language: Ruby
- Homepage: https://github.com/khusnetdinov/kazan
- Size: 146 KB
- Stars: 26
- Watchers: 2
- Forks: 4
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kazan [](https://travis-ci.org/khusnetdinov/kazan) [](https://gemnasium.com/github.com/khusnetdinov/kazan) [](https://codeclimate.com/github/khusnetdinov/kazan) [](https://badge.fury.io/rb/kazan) [](https://www.codetriage.com/khusnetdinov/kazan)
Kazan creates rails project and setups predefined gems and tools.
## Installation
Install gem:
$ gem install kazan
## Usage
By default this rails application generator uses PostgreSQL as db and RSpec as test framework. Also it installs and setups a lot usefull gems, and you don't need waste time then you stat new project.
Just run:
$ kazan projectname
This generator maps all flags to rails native generator, for example you can create api application:
$ kazan projectname --api
See all gems that will be installed to project in [Gemfile](https://github.com/khusnetdinov/kazan/blob/master/templates/Gemfile.erb) for web application or for api [Gemfile.api](https://github.com/khusnetdinov/kazan/blob/master/templates/Gemfile.api.erb).
## Gems
It includes applications gems:
- [Dotenv](https://github.com/bkeepers/dotenv) Shim to load environment variables from .env into ENV in development.
- [I18n](https://github.com/svenfuchs/rails-i18n) is central point to collect locale data for use in Ruby on Rails.
- [MetaTags](https://github.com/kpumuk/meta-tags) a gem to make your Rails application SEO-friendly. Gem is not generated if --api is selected.
- [PostgreSQL](https://www.postgresql.org/) database with [PG](https://rubygems.org/gems/pg/versions/0.18.4) adapter is used by defaul.
- [Puma](http://puma.io/) is a simple, fast, threaded, and highly concurrent HTTP 1.1 server for Ruby/Rack applications.
- [Rack Timeout](https://github.com/heroku/rack-timeout) aborts requests that are taking too long; an exception is raised.
- [Rails 5.2.0](http://rubyonrails.org/)
- [Rails Config](https://github.com/railsconfig/config) helps you easily manage environment specific settings in an easy and usable manner.
- [Rollbar](https://rollbar.com/) error monitoring fits right into your continuous delivery and deployment workflows to provide confidence in every code release.
- [Simple From](https://github.com/plataformatec/simple_form) [API EXCLUDED] aims to be as flexible as possible while helping you with powerful components to create your forms.
It includes assets gems [API EXCLUDED]:
- [Normalize Css](https://necolas.github.io/normalize.css/) makes browsers render all elements more consistently and in line with modern standards. It precisely targets only the styles that need normalizing.
- [Sass](http://sass-lang.com/) is the most mature, stable, and powerful professional grade CSS extension language in the world.
It includes development gems:
- [Annotate](https://github.com/ctran/annotate_models) adds a comment summarizing the current schema.
- [Awesome Print](https://github.com/awesome-print/awesome_print) prints pretty Ruby objects in full color exposing their internal structure with proper indentation.
- [Better Errors](https://github.com/charliesome/better_errors) [API EXCLUDED] replaces the standard Rails error page with a much better and more useful error page.
- [Brakeman](https://github.com/presidentbeef/brakeman) is an open source static analysis tool which checks Ruby on Rails applications for security vulnerabilities.
- [ByeBug](https://github.com/deivid-rodriguez/byebug) is a simple to use, feature rich debugger for Ruby 2.
- [Bundler Audit](https://github.com/rubysec/bundler-audit) is patch-level verification for bundler.
- [Bullet](https://github.com/flyerhzm/bullet) is designed to help you increase your application's performance by reducing the number of queries it makes.
- [Foreman](https://github.com/ddollar/foreman) procfile-based applications.
- [Letter Opener](https://github.com/ryanb/letter_opener) previews email in the default browser instead of sending it.
- [Listen](https://github.com/guard/listen) listens to file modifications and notifies you about the changes.
- [Pry](https://github.com/rweng/pry-rails) for interactively exploring objects.
- [Rack Mini Profiler](https://github.com/MiniProfiler/rack-mini-profiler) [API EXCLUDED] displays speed badge for every html page.
- [Reek](https://github.com/troessner/reek) - code smell detector for Ruby.
- [RuboCop](https://github.com/bbatsov/rubocop) is a Ruby static code analyzer. Out of the box it will enforce many of the guidelines outlined in the community [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide).
- [scss-lint](https://github.com/brigade/scss-lint) is a tool to help keep your [SCSS](http://sass-lang.com/) files clean and readable by running it against a collection of configurable linter rules.
- [Spring](https://github.com/rails/spring) speeds up development by keeping your application running in the background.
- [Web Console](https://github.com/rails/web-console) [API EXCLUDED] is a debugging tool for your Ruby on Rails applications.
It includes tests gems:
- [Capybara](https://github.com/jnicklas/capybara) [API EXCLUDED] helps you test web applications by simulating how a real user would interact with your app.
- [Database Cleaner](https://github.com/DatabaseCleaner/database_cleaner) is a set of strategies for cleaning your database in Ruby.
- [Factory Bot](https://github.com/thoughtbot/factory_bot) is a fixtures replacement with a straightforward definition syntax.
- [Faker](https://github.com/stympy/faker) a port of Perl's Data::Faker library that generates fake data.
- [Formulaic](https://github.com/thoughtbot/formulaic) [API EXCLUDED] the tedium of formulaic form filling with Capybara.
- [I18n-Tasks](https://github.com/glebm/i18n-tasks) [API EXCLUDED] Gem that helps manage locales and test if are there problems.
- [I18n-Yaml-Sorter](https://github.com/redealumni/i18n_yaml_sorter) [API EXCLUDED] Sort all locales by keys.
- [Launchy](https://github.com/copiousfreetime/launchy) [API EXCLUDED] helper class for launching cross-platform applications in a fire and forget manner.
- [Rspec](https://github.com/rspec/rspec-rails) is a testing framework for Rails.
- [Simplecov](https://github.com/colszowka/simplecov) is a code coverage analysis tool for Ruby.
- [Shoulda Matchers](https://github.com/thoughtbot/shoulda-matchers) provides RSpec- and Minitest-compatible one-liners that test common Rails functionality.
- [Timecop](https://github.com/travisjeffery/timecop) providing "time travel" and "time freezing" capabilities, making it dead simple to test time-dependent code.
- [Web Mock](https://github.com/bblimke/webmock) for stubbing and setting expectations on HTTP requests in Ruby.
## Bonuses
- t() and l() in specs without prefixing with I18n.
- Low database connection pool limit.
- Rails' flashes set up and in application layout.
- [Rack::Deflater](https://robots.thoughtbot.com/content-compression-with-rack-deflater) to compress responses with Gzip.
- [Safe binstubs](https://github.com/thoughtbot/suspenders/pull/282).
- Ready Seo controller with methods for generating files - robots.txt,
sitemap.xml.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).