Run the Ruby on Rails sample app

A quick check

Make sure you have the following ready:

A Kontent.ai account
Ruby 3.1 installed
Your favorite IDE, for example, Visual Studio Code
- See how to set up Ruby development on Windows

Prepare your sample project

Kontent.ai comes with a few sample projects to showcase best practices. The Ruby sample app is built around one of them.

Here’s how you can create your own sample project:

In Kontent.ai, click your initials in the bottom left corner.
Select Projects.
At the end of the list, click Create complete sample project.
Select a subscription for the project.
Click Create project.

You now have a project named Sample Project you can use with the sample app!

Clone the app

Clone

the sample app's repository

to your device.

Connect your Kontent.ai project

Connect the app to your Sample Project so you can freely make changes.

In Kontent.ai > Environment settings > General > Environment ID, copy the Environment ID for Production.
In the sample app folder, open the /app/controllers/application_controller.rb file in your code editor.
On line 3, replace <your-project-id> with your production environment ID.
Save the file.

Run the app

In your command line, open the cloned repository.
Run bundle install to install the necessary gem packages.
Run the rails server to start the app.

Open localhost:3000

in your browser to see the running sample app.Now, let’s explore the Sample Project and update its content so that you can see the changes reflected in your locally running application.