Rails Bootstrap UI
👋 Welcome to Rails Bootstrap UI.
A UI framework for Ruby On Rails, based on Bootstrap.
This website is built using Lookbook.
If you find it useful, give it a ⭐️ on GitHub.
What does Rails Bootstrap UI do? 🤨
- It edits some default Bootstrap variables to make all bootstrap components look more modern.
- It gives more examples of how to combine existing Bootstrap classes to create new components.
It adds animationsWIP- It adds some new components that are not present in Bootstrap, using, for example other libraries.
- It show examples on how to use these components in your Turbo-powered Rails app. This means that we will use Stimulus controllers to attach javascript behavior to our components.
Have a look at the Buttons to see an example of a simple Bootstrap component, or at the Avatar to check how you can combine existing utility classes to obtain new components.
Development principles 🛠️
- Ruby On Rails: we don't aim to make this UI framework work without Rails. It's Rails-specific.
- Bootstrap: we want to use Bootstrap as the base for our components. There are many other UI Frameworks based on Tailwind out there: this is a Bootstrap one.
- SCSS: sass is a dependency of this project. We will strive to use pure CSS whenever this is possible.
- Rails-frontend agnostic: we don't want any dependency over ViewComponent or Phlex or other libraries, although we ❤️ them. We might still use those to provide some integration examples, but they are not a requirement.
- Hotwire-ready: we will use stimulus controllers to attach javascript behavior to our components. Stimulus is our guarantee that each component is hotwire-ready.
- This is developed by Renuo AG, a Swiss software company. It is open-source and free to use, but the main goal is to provide a better developer experience for our developers. ## What do you get with Rails Bootstrap UI
At the moment this is a Website that shows you how to use the components. You can easily copy-paste the code to your app or take inspiration.
We would like, in the future, to also provide a rails-bootstrap-ui
gem that you can bundle.
Thanks ❤️
Thanks to Lookbook for providing a great way to document components.
Thanks to Renuo AG for sponsoring this project.