Running the Vue sample application

New to headless CMS?

If you are new to the world of headless CMSs, you might want to start by building a Hello world application. It will only take you about 5 minutes!

After you grasp the core idea behind a headless CMS, everything in the sample application will make a lot more sense much faster.

In this guide, you'll get a brief introduction to website development practices with Kentico Cloud. We will start by running a Vue sample application on your machine and updating an article in the sample project. Then we will explore how the content of the article is structured.

Every subscription of Kentico Cloud comes with a Dancing Goat sample project that demonstrates our features and best practices. The project contains marketing content for an imaginary chain of coffee shops. This content is used in our sample applications.

Note:

For this tutorial, we are going to use the Vue sample application. If you're more familiar with React or .NET, we have tutorials for those as well.

Running the Vue sample app

Before going any further, make sure you have the following:

1. Download the app

The source code of the sample application lives in a Github repository.

If you are used to working with Git, you can clone the repository to your computer by typing the following into your console:

git clone https://github.com/Kentico/cloud-sample-app-vue.git

If you don't have Git installed, you can download the sample application directly as a ZIP file, extract it, and continue from there.

2. Run and configure the app

  1. Navigate to the root folder of the application in the command line.
  2. Type npm install to install the required npm packages.
  3. Type npm run serve to start a development server.

The application will open automatically in your browser at http://localhost:8080.

First run of the sample app

First run of the sample app

When you run the application for the first time, you will see a Configuration page. Use it to connect the app to your sample project in Kentico Cloud:

  1. Click Get project ID from Kentico Cloud. A new browser window will open.
  2. Sign in to your account or create a new one.
  3. From the list of your projects, select the Sample project.
  4. Click Select project.

The application now displays content from your sample project.

Note: You can also set the project ID manually.

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 signing in to your Kentico Cloud account you will see your sample project to play around with.

Your welcome screen is a list of all the pieces of content in your project (we call them content items).

You can search for a content item by name or apply filters to quickly find what you are looking for:

  • In the filter panel on the left, select the Article content type to view only articles.
Filtering content by content type

Filtering content by content type

  • Click one of the articles to edit it. For example, try the Coffee processing techniques article. (Inside the running app, navigate to Articles -> Coffee processing techniques to see how the content is actually displayed.)
Details of a published content item

Details of a published content item

Updating a published article

The article is currently published, meaning it's publicly accessible and, as such, cannot be updated directly.

To edit the article:

  1. On the Details panel, click the Published workflow step.
  2. Click Create a new version. The old version stays up, while you edit the new version.
  3. Edit the text of the article or change its teaser image.

Your changes will be saved automatically, but to make them visible in the application, you have to publish the new version of your article.

To publish the article:

  1. On the Details panel, click the Draft workflow step.
  2. Select the Review workflow step
  3. Assign yourself as a contributor.
  4. Click Change workflow at the bottom of the side panel.
  5. On the Details panel, click the Review workflow step.
  6. Select the Publish workflow step.
  7. Click Publish at the bottom of the side panel.

Note: You can later customize the content workflow according to your needs.

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 the sample project and the sample application.

The advantage of using Kentico Cloud lies in the freedom to define how your content is structured. Let's see an example inside the sample project itself.

Exploring content structure

The Details panel shows us that our Coffee processing techniques content item is based on the Article content type.

  1. From the app menu, choose Content models.
  2. Click the Article content type to open it.

How content is structured in Kentico Cloud

Content item is any piece of content in your project. It is made up of content 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 content elements it contains, their names, restrictions, guidelines, and so on.

You can mix and match the available content elements to define your own content types.

Deploying the Vue sample app

When using a headless CMS like Kentico Cloud to power a single page application, you don't necessarily have to write any server-side code. Because the application only requires static resources, you have many interesting deployment options available to you.

Here, we are going to use Surge to deploy your React sample application:

  1. Navigate to the root folder of the application in the command line.
  2. Type npm install --global surge to install Surge on your computer.
  3. Type npm run build to build the application and make it production-ready.
  4. Type cd dist to navigate to the build folder.
  5. Type surge to deploy your application. The first time you do this, Surge will prompt you to set up your account. Every other time it will confirm the build directory and generate a funny subdomain for your app.

You can change the sub-domain if you like and can even use your own domain, all for free. After that, you’re done. The site is deployed and ready to be accessed on the domain specified during deployment.

Summarized

Kentico Cloud 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 Cloud 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.

What's next

  • Have a look at our available SDKs, sample applications and tools for JavaScript.
  • Looking for inspiration? See what people are building with Kentico Cloud in our case studies and development blog.
  • For more information about the user interface and the content creation process, visit our Help Center.