administrate-bootstrap-theme 0.2.2 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f5c9e7796dff0685744b42182407312126a508ea641a1160f751fbef5c1bf9f
-  data.tar.gz: d978d2e0541202ea70fc6f950eb9206e4f4bd91a4dcf95fed51d1e9f1f59e981
+  metadata.gz: aaa5f115d75e691b8a58fc48fae125239e19afb54a0666ed1bcb278d6c215db5
+  data.tar.gz: eed5a7db1ef5bf99693f472c6f3df0e305f491c71ce9f7e5ddeabb5b382eaee6
 SHA512:
-  metadata.gz: 7a710260a02ce0c73a8be1dfc7c34feb095088b777d3f402b0e8882748d5c3e131cf2ac79b3ab7dec0e9254ca97bd26c3a3608e9b91d1eb0c849b9b907581e78
-  data.tar.gz: 695d8e6a10925f2567016f443135ac9ed3ebeb821419b63f148d5a63a9d28f3082d67f3ecb9e0ec6e2de76f3b78019b6554c29823e584a55d4353cafac15e93c
+  metadata.gz: e181760902fa5b61dee3329b80f40ae5186a657b0763c97b954315e13af6e80cf67d88b6f50f0c7a11ade4cf6bed276c043614b90b7fe3f855198b826e95e4db
+  data.tar.gz: ad94e6464663098d6cb2df4b5ba393cd798e0fff3b4b70b6375c334343497aaa87fa919ed474b7ddb873bb8c2736367e2b0185fc7b3ab00467c265090b72a78b

data/README.md

@@ -1,63 +1,96 @@
-# Administrate Bootstrap Theme [![Gem Version](https://badge.fury.io/rb/administrate-bootstrap-theme.svg)](https://badge.fury.io/rb/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)
+# 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)
+[![CodeQL](https://github.com/blocknotes/administrate-bootstrap-theme/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/blocknotes/administrate-bootstrap-theme/actions/workflows/codeql-analysis.yml)
 
 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).
 
-## Installation
+Please :star: if you like it.
 
-- Add to *Gemfile* (of an Administrate project): `gem 'administrate-bootstrap-theme'` (and execute `bundle`)
-- Add to *app/assets/config/manifest.js*:
+## Installation
 
-```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
+### Extra improvements
 
-To change variables it's necessary to create a new *.scss* (or *.sass*) file like this one (ex. *admin.scss*):
+Choose a predefined color schema - *app/assets/stylesheets/administrate-bootstrap-theme.scss*:
 
 ```scss
-// app/assets/stylesheets/admin.scss
-$navigation-bg: #055160;
-$navigation-bg-active: #d51;
-$navigation-width: 300px;
-$primary: #087990;
-
+@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, 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!