No release in over a year
A Bootstrap theme for Administrate: clean design, easy to install, customizable
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

 Project Readme

Administrate Bootstrap Theme

gem version gem downloads linters specs CodeQL

A Bootstrap 5 theme for Administrate.

Features:

  • easy to install: just run the generator installer;
  • customizable via SASS variables;
  • allow to use Bootstrap components in the admin.

See some screenshots.

Please ⭐ if you like it.

Installation

  • 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

Customizations

Edit the variables defined in app/assets/stylesheets/administrate-bootstrap-theme.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;

@import 'administrate-bootstrap-theme/theme'; // required after the variables setup

Extra improvements

Choose a predefined color schema - app/assets/stylesheets/administrate-bootstrap-theme.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';

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:
@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 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:
en:
  administrate:
    navigation:
      back_to_app: 'MyAdmin'
  • to add a copyright line at the bottom, update the links part with:
<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, show and edit pages: Administrate Bootstrap Theme sections
  • Index page with some customized colors: Administrate Bootstrap Theme index page customized
  • Color schemas (none, default, autumn, forest, water, industrial): Administrate Bootstrap Theme colors

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.

Contributors

License

The gem is available as open source under the terms of the MIT License.