Installation - RapidRails UI Documentation

Prerequisites

Tailwind CSS: The installer will set up Tailwind CSS v4 automatically if not already installed.

After purchasing, you'll receive:

Run this command to save your Gemfury credentials (one-time setup):

bundle config gem.fury.io YOUR_GEMFURY_TOKEN

Replace YOUR_GEMFURY_TOKEN with the token from your purchase confirmation email.

Note: This stores credentials in ~/.bundle/config (not in your project), keeping them out of version control.

Add the gem source and dependency to your Gemfile:

# Gemfile

source "https://gem.fury.io/rapidrailsui" do
  gem "rapid_rails_ui"
end

Then run:

bundle install

Run the installer to configure everything automatically:

rails generate rapid_rails_ui:install

The installer will set up Tailwind CSS, dark mode, Stimulus controllers, and all necessary configuration.

After installation: Restart your Rails server to load the new components.

License validation is automatically skipped in development and test environments. You can start building immediately!

For production, set the environment variable on your hosting platform:

export RAPID_RAILS_UI_LICENSE_KEY=RRUI-PRO-YOURKEY-S1-D5-20261231-CHECKSUM

Or use Rails credentials:

# config/credentials.yml.enc
rapid_rails_ui:
  license_key: RRUI-PRO-YOURKEY-S1-D5-20261231-CHECKSUM

# config/application.rb
ENV['RAPID_RAILS_UI_LICENSE_KEY'] = Rails.application.credentials.dig(:rapid_rails_ui, :license_key)

Add a button to any view to confirm everything works:

<%= rui_button("Hello World", color: :success) %>

You should see:

Done! You're ready to start building.

For automated deployments, configure your CI environment with the Gemfury token:

env:
  BUNDLE_GEM__FURY__IO: ${{ secrets.GEMFURY_TOKEN }}

heroku config:set BUNDLE_GEM__FURY__IO=your-gemfury-token

ARG GEMFURY_TOKEN
RUN bundle config gem.fury.io ${GEMFURY_TOKEN}