Bootgenie

A Bootstrap theme for The Bug Genie. Aim is to create a visually neutral but modern and fully responsive theme which fits well with other software using Bootstrap (eg. GitList).

Requirements

• The Bug Genie 4.0 or later (commit e3ec660 introduced the ability to override the core layout)
• An extra webserver redirect rule to serve any /assets URL from /modules/bootgenie/assets

Roadmap

• Conversion:
  • ✓ Convert every most important pages to be usable with Bootstrap
  • ✓ Strip every original JavaScript and classes (keep ids for later)
  • ✓ Insert necessary markup for Bootstrap (will be cleaned up later)
• Cleanup:
  • Replace every Bootstrap related markup with proper SCSS or JavaScript bindings
  • Maintain a wiki page with the clean markup for reference
  • Make the HTML output indent properly and nice to look at
• Specification:
  • Make a specification with the original The Bug Genie theme so every feature can be compared, checked and tested
  • Possible unit or gui testing (?)
• Enrichment:
  • Add back dynamic JavaScript features

Documentation

The documentation is available as a Github Wiki and it is also shipped with the module as Asciidoc files in the docs folder. If you used git do download the sources the docs is a git submodule.

Development

Fork the repository on Github and clone that or just the original:

git clone [email protected]:gabor-udvari/bootgenie.git

Step into the directory and install the dependencies with Composer:

cd bootgenie
composer install

Composer will install everything you need, even the assets. After that you can use Robo to build the assets:

vendor/bin/robo build

Why a module and not a theme?

The Bug Genie has a lot more powerful support for modules than themes. Modules support version numbering, install, upgrade, uninstall hooks and a lot more.

License information

• If not otherwise noted: MPL 2.0 (same as The Bug Genie 4.0)
• Bootstrap: MIT
• Yamm3: MIT