Configuration

For best results, use Rails UI for new Ruby on Rails applications.

What happens when Rails UI is installed?

When you run the Rails UI installer and theme installer generators the following happens:

1. 1. Generate a custom configuration yaml file railsui.yml that's required to theme your new app.
2. 2. Install dependencies and any necessary assets.
3. 3. Generate a custom tailored design system for repeatable web elements. Think of this as a system for providing design direction when creating new features. This includes typography, font elements, and SVG icons.
4. 4. Optionally install one-off templates (i.e. About us, Pricing, etc...). Use these as a starting point.
5. 5. Install scaffold templates that follow the theme and CSS framework you chose.

After installing the Rails UI gem and running the installer, you may configure your application preferences.

Configuration is a simple process that first prompts you for an application name and preferred CSS framework.

Rails UI currently ships with support for Bootstrap and Tailwind CSS.

Select a theme

After selecting and saving the CSS framework, new sections appear for further tweaking.

The first section is a theme gallery. This section is a place to choose a starting point for the overarching design of your application. Each theme includes a preview to get a feel for the design and layout.

Install pages

Because each theme is built from scratch, you may optionally configure Rails UI to generate a theme with additional pages automatically.

Once installed you may view these pages right inside your application.

Additional pages and templates will follow as Rails UI ages.