Run the Ruby on Rails sample app
In this guide, you'll learn how to run a basic Ruby on Rails sample app and see your project's content in your browser. The sample app will show content from a sample project and you'll also get to change a thing or two in the project.
New to Content as a Service?
If you are new to the world of Content as a Service (CaaS), you might want to start by building a Hello world application.
After you grasp the core idea behind CaaS, everything in the sample application will make a lot more sense much faster.
Table of contents
Sample project for the app
The sample app displays data from the Sample Project that demonstrates our best practices and features of Kentico Kontent. If you don't have it yet, create your own sample project, it only takes a minute.
This full-featured project contains marketing content for Dancing Goat – an imaginary chain of coffee shops. Once you run the sample app, you'll see content from the Sample Project displayed in your browser.
Running the Ruby on Rails sample app
Before going any further, make sure you have the following:
- A Kentico KontentOpens in a new window account
- Ruby 2.5Opens in a new window installed (check how to setup Ruby development environment on WindowsOpens in a new window)
- Your favorite code editor, for example, Visual Studio CodeOpens in a new window
1. Download the app
The source code of the sample application lives in a Github repositoryOpens in a new window of the Ruby SDK.
If you are used to working with GitOpens in a new window, you can clone the repository to your computer by typing the following to your console:
- shellgit clone https://github.com/Kentico/kontent-delivery-sdk-ruby.git
git clone https://github.com/Kentico/kontent-delivery-sdk-ruby.git
If you don't have Git installed, you can directly download the sample application as a ZIP fileOpens in a new window, extract it, and continue from there.
2. Connect your Kontent project
By default, the sample app uses a shared sample project. We recommend connecting the app to your own Sample Project so that you can freely make changes and play with it.
- In the sample app folder, open the
/dancing_goat/app/controllers/application_controller.rbfile in your code editor.
- On line 3, change
<your-project-id>to your actual Sample Project ID.
- You can find your project ID in Project settings > API keys > Delivery API card > Project ID field.
- Save the file.
3. Run the app
- In your command line, open the cloned repository.
- Navigate to the dancing_goat folder.
bundle installto install the necessary gem packages.
- Run rails server to start the app.
localhost:3000Opens in a new window 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.
Making changes to your project
After you sign in to Kentico Kontent, you'll see your Sample Project to play around with. We recommend you get familiar with content items and how to find stuff in your projects. It's simple yet powerful.
Try to edit an article from the sample project:
- From the app menu, choose Content & Assets.
- Open a published article, for example, the Coffee processing techniques one.
- Look for items with a green Published label and the word Article in the Type column.
- Create a new version to edit the article.
- Make a change in the article, for example, edit the Title text or some other element.
- Publish the changes to see them in the sample app.
Voila! You have successfully updated content in your Sample Project. Refresh the browser window with your application to see the changes on the website.
Feel free to further explore how the content in your sample project is structured.
Exploring content structure
To see details about the opened content item, go back to Kentico Kontent and click Content details in the top right. Under Content type, notice that the item is based on the Article content type.
To open the content type for editing, click Article in the content details.
How content is structured in Kentico Kontent
Content item is any piece of content in your project. It is made up of elements, such as texts, images, files, etc.
Each content item is based on a single content type. A content type is a template that defines the structure of the content item – which elements it contains, their names, limitations, guidelines, and so on.
Mix and match the available elements to define your own content types.
Kentico Kontent makes no assumptions about how your content is displayed. It simply delivers it via a RESTful Delivery API to any application that asks for it – be it a website, mobile app, chatbot, electronic billboard, virtual voice assistant or an internet-enabled toaster.
We deliver the content, you do whatever you want with it – using the technology of your choice.
A traditional CMS would force you to put your content into neatly arranged boxes to fit inside a pre-defined template. The power of Kentico Kontent comes from not getting in your way. Content structure and content presentation are truly separated and you have the flexibility to define both according to the needs of your project.