Quickstart guide

Thanks so much for choosing Rails Designer’s UI Components Library! ❤️ You have joined many Rails teams and solo-developers around the globe to build beautiful, faster.

The library is packaged as a private gem. This allows for new components, updated variants and so on, to be just one bundle update away.

One command to install

The quickest way to install it is to run this command in your Rails app’s folder: rails app:template LOCATION="https://railsdesigner.com/setup/".

You are asked for your private key and both your preferred primary- and gray color.

Preview of the quickstart CLI command to install Rails Designer in your app

View the Component Library

After restarting your server, you can navigate to /rails_designer to view the components library.

Generate your first component

You can now generate your first component, for example the Badge Component. Simply click the button Run Generator or manually in your console: bin/rails generate rails_designer:component Elements::Badge.

If you find yourself needing help with any of these steps, even after giving them a good try, don’t hesitate to reach out to support.