Installation

Create a new app

Installing Rails UI begins by creating a new vanilla Rails application. At this time, Rails UI requires all applications to be new apps.

Before installing the gem, ensure both your node and yarn versions are up to date for best results.

Using something like nvm helps managing node versions less of a chore. I like to use homebrew for yarn and periodically run brew upgrade yarn.

Using the latest versions of these libraries allows additional scripts to run and insert build scripts dynamically to your app. TL;DR; The more up to date your version the less manual configuration you'll need to do.

Create a vanilla Rails app

You might be tempted to pass options when creating a new app to install a CSS framework or JavaScript framework. We recommend waiting to do this until completing all configuration steps.

All other options related to tests, skipping APIs, database types, and more can be passed.

During the configuration process, Rails UI automatically installs the CSS framework of your choice (in a similar manner as the cssbundling-rails and jsbundling-rails Ruby gems) thus making the optional flags unnecessary. esbuild is the default solution for JavaScript.