Installation & Update
Last updated
Last updated
Make sure to install and get to know matestack-ui-core
first!
Add the Ruby gem and NPM package:
Adjust the relevant application layout and add a div with the ID matestack-ui
app/views/layouts/application.html.erb
Tell Webpack to import Bootstraps CSS:
app/javascript/packs/stylesheets/application.scss
Import the required JS libraries and mount MatestackUiCore and MatestackUiBootstrap properly. We recommend to remove Turbolinks, as it might interfere with some of the reactivity feature of Matestack:
app/javascript/packs/application.js
Download and import Bootstraps icons:
app/assets/images/icons
extract the bootstrap-icons.svg to this path: app/assets/images/icons (currently served via assets pipeline, we had issues serving the icons via Webpack)
and finally compile the code with webpack:
When you update the matestack-ui-bootstrap
Ruby gem, make sure to update the npm package as well!
Depending on the entry in your Gemfile, you might need to adjust the allowed version ranges in order to update the Gem. After checked and adjusted the version ranges, run:
and then check the installed version:
If you've installed the JavaScript dependecies via Yarn/Webpacker you need to update the JavaScript assets via yarn:
and finally check if the correct version is installed:
The Ruby gem version and the NPM package version should match!
download latest compatible icons: