IntelliJ IDEA 2019.2 Help

Opening and Running a Rails Project

In this tutorial, we’ll show you how to clone an existing Rails application, configure the Ruby interpreter, install dependencies, and run this application. The following application will be used for this purpose: Sample Rails App.

Prerequisites

Before working with Rails projects in IntelliJ IDEA, make sure that the following prerequisites are met:

Check out a project

First, we need to clone the repository containing the sample application:

  1. On the Welcome Screen, click Check out from Version Control and select Git.

    Welcome Screen
  2. In the invoked Clone Repository dialog, insert the following repository address to the URL field: https://bitbucket.org/rubyminedoc/sample_rails_app.git.

    Clone Repository dialog

    Then, click the Clone button.

  3. After cloning the repository, you will be prompted to create an IntelliJ IDEA project from these sources.

    Checkout from Version Control

    Click Yes.

  4. In the invoked Import Project wizard, click Next on each page of the wizard leaving the default settings.

    Import Project wizard
  5. On the last page, click Finish.

    Import Project wizard

Configure Ruby SDK

Now we need to configure the Ruby interpreter for the project:

  1. Go to File | Project Structure, or press Ctrl+Shift+Alt+S.

  2. In the invoked Project Structure dialog, switch to the Modules page and select the Ruby interpreter.

    Project Structure dialog / Module page

    Click OK.

Install gems

To install gems specified in the project’s Gemfile, do the following:

  1. Press Ctrl twice and enter the following command: gem install bundler.

    Run Anything / gem install bundler

    Press Enter and wait until the Bundler gem is installed.

  2. Press Ctrl twice again and start typing bundle install. Then, select the bundle install command from the list and press Enter.

    Run Anything / bundle install
  3. In the invoked Bundle Install dialog, click Install.

    Bundle Install dialog
  4. Wait until IntelliJ IDEA installs all gems.

    Run Tool window / installing gems

Run migrations

To run our Rails application, first we need to migrate the database:

  1. Press Ctrl twice and type db:migrate. Select rake db:migrate in the dropdown and press Enter.

    Run Anything / rake db:migrate
  2. Leave the default settings in the invoked Execute ‘db:migrate’ dialog and click OK.

    Execute db:migrate
  3. Wait until the migration is finished.

    Run tool window / running migrations

Run the application

To run our Rails application, we need to create a corresponding Rails configuration:

  1. Press Ctrl+Shift+A and start typing edit configurations. Select Edit Configurations and press Enter.

    Find Action
  2. In the invoked Run/Debug Configurations dialog, click Add New Configuration and select Rails.

    Run/Debug Configurations dialog
  3. Change the created configuration name to development and enable the Run browser option.

    Run/Debug Configurations dialog
  4. Press Ctrl twice and start typing the name of the created configuration (development). Select it from the list and press Enter.

    Run Anything / run configuration
  5. In the Run tool window, IntelliJ IDEA will show the process of preparing the application to run ...

    Run tool window / run Rails application

    ... and then open the application in a browser.

    Rails application in a browser
Last modified: 23 August 2019