Quick Start Guide

Step 1: Install Rails UI

Add the gem to your application.

# Add free version to Gemfile
bundle add railsui

# Install and setup (use --build for build mode)
rails railsui:install

Read more about build mode.

Step 2: Choose an App Kit

• New apps: visit localhost:3000 (or your preferred port) to see the Rails UI start page.
• Existing apps: visit localhost:3000/railsui/start.

Choose the kit closest to your product's workflow. You can change colors, copy, and views later; the first decision is about the screens you want to start from.

Step 3: Replace Your Forms

To see immediate UI changes, opt into Railsui::FormBuilder. The builder dynamically inherits styles from your Tailwind CSS setup and active Rails UI app kit.

Replace default Rails forms:

<%= form_with model: @user do |form| %>
  <div>
    <%= form.label :email %>
    <%= form.email_field :email %>
  </div>
  <div>
    <%= form.label :password %>
    <%= form.password_field :password %>
  </div>
  <%= form.submit "Sign In" %>
<% end %>

With beautiful Rails UI forms:

<%= form_with model: @user, builder: Railsui::FormBuilder do |form| %>
  
  <%= form.email_field :email, label: "Email address", placeholder: "you@example.com", required: true %>
  
  <%= form.password_field :password, label: "Password", required: true %>

  <%= form.submit "Sign in" %>
<% end %>

Step 4: Extend

Next Steps