administrate-bootstrap-theme 0.2.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cad69b75862fbb6154ec991a8229815262947ab8e2feb50f534b4144d868c827
-  data.tar.gz: 221e38d25bd3fac6e3acd4a551cdb1cb812597c072c2aef10591ec3fbec40390
+  metadata.gz: 6c469872149e9ebaf3ed3f3ddaaecca287b5d84ddf8dbed7b53c4d564a6826cd
+  data.tar.gz: 124aa1f1f9802e81de1757dadf0260e2248564061864fa39419633ac58ac5287
 SHA512:
-  metadata.gz: d92b856f83e57d4fa11c3bc97ced72eb5fb7f035b0a9962d15a20f9e669ff56d4ec0b6f598efc5e7ac18a5f2a9b114cdb06ce5e273742bd39aeaed1ba7f9c487
-  data.tar.gz: c9d94ca184cb4ad5ce32adb14aaf67ba807839c7d3a5223b076c3bea1bbf0fb6ef01e70a33006254186a2c6b5204eac2e46ca0b533a76a776cf7cc4e362b9f47
+  metadata.gz: 4048036b1a91e27f1eb248368899f528a80f098bc1319aaee940a22a5dbfef5917bb53f044c74230a50063fcc39d19af486a1588e8d3718b409daf20559fced0
+  data.tar.gz: 327f630cd85bf0e28d552f5a5b21496aeaa0f376fd26d92f380f1e1170ca94cfd6cc48cb74b272fa64c9ee8811307481ad6f37c896e63f639c1c323350cbdf7f

data/README.md

@@ -1,72 +1,106 @@
-# Administrate Bootstrap Theme [![Gem Version](https://badge.fury.io/rb/administrate-bootstrap-theme.svg)](https://badge.fury.io/rb/administrate-bootstrap-theme) [![Specs](https://github.com/blocknotes/administrate-bootstrap-theme/actions/workflows/specs.yml/badge.svg)](https://github.com/blocknotes/administrate-bootstrap-theme/actions/workflows/specs.yml)
+# Administrate Bootstrap Theme
+[![gem version](https://badge.fury.io/rb/administrate-bootstrap-theme.svg)](https://badge.fury.io/rb/administrate-bootstrap-theme)
+[![gem downloads](https://badgen.net/rubygems/dt/administrate-bootstrap-theme)](https://rubygems.org/gems/administrate-bootstrap-theme) 
+[![linters](https://github.com/blocknotes/administrate-bootstrap-theme/actions/workflows/linters.yml/badge.svg)](https://github.com/blocknotes/administrate-bootstrap-theme/actions/workflows/linters.yml)
+[![specs](https://github.com/blocknotes/administrate-bootstrap-theme/actions/workflows/specs.yml/badge.svg)](https://github.com/blocknotes/administrate-bootstrap-theme/actions/workflows/specs.yml)
 
-A Bootstrap 5 (_beta_) theme for [Administrate](https://github.com/thoughtbot/administrate).
+A Bootstrap 5 theme for [Administrate](https://github.com/thoughtbot/administrate).
 
 Features:
-- easy to install, just include CSS/JS to apply the theme to a default Administrate structure;
+- easy to install: just run the generator installer;
 - customizable via SASS variables;
 - allow to use *Bootstrap* components in the admin.
 
 See some [screenshots](#screenshots).
 
+Please :star: if you like it.
+
 ## Installation
-- Add to *Gemfile* (of an Administrate project): `gem 'administrate-bootstrap-theme'` (and execute `bundle`)
-- Add to *app/assets/config/manifest.js*:
 
-```js
-//= link administrate-bootstrap-theme/theme.css
-//= link administrate-bootstrap-theme/theme.js
-```
+- Add to *Gemfile* (of an Administrate project): `gem 'administrate-bootstrap-theme', '~> 1.0'` (and execute `bundle`)
+- Run the installer: `bin/rails generate administrate_bootstrap_theme:install`
 
-- Generate the layout views if they are missing: `rails generate administrate:views:layout` (only **_stylesheet** and **_javascript** partials are needed)
-- Update *app/views/admin/application/_stylesheet.html.erb*, leaving only:
+## Customizations
 
-```erb
-<%= stylesheet_link_tag 'administrate-bootstrap-theme/theme', media: 'all' %>
-<%= yield :stylesheet %>
-```
+Edit the variables defined in *app/assets/stylesheets/administrate-bootstrap-theme.scss*:
 
-- Update *app/views/admin/application/_javascript.html.erb*, leaving only:
+```scss
+$navigation-width: 250px;
+$navigation-bg: #055160;
+$navigation-bg-active: #d51;
+$navigation-fg: #eee;
+$primary: #0d6ecd;
+$secondary: #666;
+$main-content-bg: #f4f8fb;
+$main-content-fg: #222;
 
-```erb
-<%= javascript_include_tag 'administrate-bootstrap-theme/theme' %>
-<%= yield :javascript %>
+@import 'administrate-bootstrap-theme/theme'; // required after the variables setup
 ```
 
-## Customizations
-To change variables it's necessary to create a new *.scss* (or *.sass*) file like this one (ex. *admin.scss*):
+### Extra improvements
 
-```scss
-// app/assets/stylesheets/admin.scss
-$navigation-bg: #055160;
-$navigation-bg-active: #d51;
-$navigation-width: 300px;
-$primary: #087990;
+Choose a predefined color schema - *app/assets/stylesheets/administrate-bootstrap-theme.scss*:
 
+```scss
+@import 'administrate-bootstrap-theme/colors/default';
+// @import 'administrate-bootstrap-theme/colors/autumn';
+// @import 'administrate-bootstrap-theme/colors/forest';
+// @import 'administrate-bootstrap-theme/colors/industrial';
+// @import 'administrate-bootstrap-theme/colors/water';
 @import 'administrate-bootstrap-theme/theme';
 ```
 
-And replace the link tag in the *application.html.erb* with: `<%= stylesheet_link_tag 'admin', media: 'all' %>`
+Set a UI font:
+
+- you can of course import any font from Google fonts (or other providers);
+- to use a pre-configured one - *app/assets/stylesheets/administrate-bootstrap-theme.scss*:
+```scss
+@import 'administrate-bootstrap-theme/fonts/roboto';
+// @import 'administrate-bootstrap-theme/fonts/lato';
+// @import 'administrate-bootstrap-theme/fonts/montserrat';
+// @import 'administrate-bootstrap-theme/fonts/open_sans';
+// @import 'administrate-bootstrap-theme/fonts/source_sans_pro';
+@import 'administrate-bootstrap-theme/theme';
+```
 
-For the complete list of options take a look [here](app/assets/stylesheets/administrate-bootstrap-theme/_variables.scss).
+For more improvements to the sidebar:
+
+- generate the navigation partial: `bin/rails generate administrate:views:navigation`
+- edit the partial *app/views/admin/application/_navigation.html.erb*
+- to change the _Back to app_ button to a title component: replace the classes for the first link (_back_to_app_) with `button--title`
+- update the translation button title editing *config/locales/en.yml*:
+```yml
+en:
+  administrate:
+    navigation:
+      back_to_app: 'MyAdmin'
+```
+- to add a copyright line at the bottom, update the links part with:
+```erb
+<div class="mb-auto">
+  <% Administrate::Namespace.new(namespace).resources_with_index_route.each do |resource| %>
+    ...
+  <% end %>
+</div>
+<div class="copy">by Mat</div>
+```
 
 ## Screenshots
-- Index page:
-![Administrate Bootstrap Theme index page](extra/screenshot_index.png)
-- Show page:
-![Administrate Bootstrap Theme show page](extra/screenshot_show.png)
-- Form page:
-![Administrate Bootstrap Theme edit page](extra/screenshot_edit.png)
-- Index page with some customized colors:
-![Administrate Bootstrap Theme index page customized](extra/screenshot_index_alt.png)
+
+- Index, show and edit pages: ![Administrate Bootstrap Theme sections](extra/screenshot_sections.png)
+- Index page with some customized colors: ![Administrate Bootstrap Theme index page customized](extra/screenshot_index_alt.png)
+- Color schemas (none, default, autumn, forest, water, industrial): ![Administrate Bootstrap Theme colors](extra/screenshot_colors.png)
 
 ## Do you like it? Star it!
+
 If you use this component just star it. A developer is more motivated to improve a project when there is some interest.
 
 Or consider offering me a coffee, it's a small thing but it is greatly appreciated: [about me](https://www.blocknot.es/about-me).
 
 ## Contributors
+
 - [Mattia Roccoberton](https://blocknot.es/): author
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).