Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tarellel/bootstrap_views_generator
A Rails generator for creating bootstrap styled views (Erb, Slim, and HAML).
https://github.com/tarellel/bootstrap_views_generator
bootstrap gem generator rails ruby template twitter-bootstrap
Last synced: about 1 month ago
JSON representation
A Rails generator for creating bootstrap styled views (Erb, Slim, and HAML).
- Host: GitHub
- URL: https://github.com/tarellel/bootstrap_views_generator
- Owner: tarellel
- License: mit
- Created: 2019-05-06T23:53:28.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-11-14T14:07:17.000Z (about 1 year ago)
- Last Synced: 2024-12-01T13:25:06.697Z (about 1 month ago)
- Topics: bootstrap, gem, generator, rails, ruby, template, twitter-bootstrap
- Language: Ruby
- Homepage:
- Size: 94.7 KB
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# BootstrapViewsGenerator
 [](http://opensource.org/licenses/MIT) [](http://rubygems.org/gems/bootstrap_views_generator "View this project in Rubygems")
This gem is used for generating Bootstrap based scaffold views for your Rails application. They can be Erb, Slim, or HAML. You can include pagination (using Pagy), simple_form (for the form components), and if you'd like you can utilize the meta-tags gems to all dynamic page titles when switching between your view components.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'bootstrap_views_generator', group: :development
# Now make sure you have the bootstrap gem installed in your Gemfile
gem 'bootstrap', '~> 4.3'
# And ensure you have bootstrap included in your application.scss
@import 'bootstrap';
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install bootstrap_views_generator
## Usage
```shell
Usage:
rails g bootstrap:install [options]
Options:
Options:
-t, [--template-engine=TEMPLATE_ENGINE] # Indicates when to generate using a designated template engine (erb, slim, haml)
# Default: erb
--simpleform # Indicates if simple_form is to be used to generate the forms
# Default: false
--pagination # Specify if you want to add pagination to the index pages
# Defaults: false (requires Pagy to use pagination)
--metatags # If you want the pages titles to use the metatags gem function for the page title
# Default: false
--layout # Over-write your application layout file with a bootstrap based layout
# Default: false
--devise # If you want to generate bootstrap based devise views
# Default: false
--skip_javascript # If you want to skip adding javascript_include_tag || javascript_pack_tag to the layouts
# Default: false
--skip_turbolinks # Do you want to skip associating turbolinks with the assets and views
# Default: false
```
## Options
##### Template Engines
Supported Template Engines
* ERB
* HAML
* Slim
**HAML**
Make sure you have haml added to your your Gemfile
```ruby
gem 'haml-rails'
# generate haml views
rails g bootstrap:install --template_engine=haml
```
**Slim**
Make sure you have Slim added to your Gemfile
```ruby
gem 'slim-rails'
# generate Slim views
rails g bootstrap:install --template_engine=slim
```
#### Pagination
Ensure you have [Pagy](https://github.com/ddnexus/pagy) gem installed
```ruby
# Gemfile
gem 'pagy'
# Make sure you have the bootstrap pagy helper included
# config/initializers/pagy.rb
require 'pagy/extras/bootstrap'
```
#### Meta-Tags
Ensure you have the [meta-tags](https://github.com/kpumuk/meta-tags) gem installed
```ruby
gem 'meta-tags'
```
### Examples
Generate bootstrap views with pagination enabled
```shell
rails g bootstrap:install --pagination
```
Generate bootstrap views with slim and using simple_form
```shell
rails g bootstrap:install --template_engine=slim --simpleform
```
Generate bootstrap scaffolds, devise views, while using simpleform, metatags, and slim template engine.
```shell
rails g bootstrap:install --devise --simpleform --metatags --template_engine=slim
```
### Extras
* If you like to use the [meta-tags](https://github.com/kpumuk/meta-tags) gem to add page titles based on the views.
* Pagination defaults to using [Pagy](https://github.com/ddnexus/pagy) on the index pages.
* With [simple_form](https://github.com/plataformatec/simple_form) it is assumed your have already run the simple_form generator for displaying bootstrap based components.
```shell
rails generate simple_form:install --bootstrap
```