Skip to content

kontent-ai/sample-app-vue

master
Switch branches/tags
Code

Kentico Kontent sample Vue.js single-page application

Netlify Status Live Demo Stack Overflow Discord

This is a sample website written in JavaScript utilizing the Kentico Kontent Delivery API to manage and retrieve content. You can register your account for free at https://app.konent.ai.

Application setup

  1. Install the latest version of NodeJS and npm. You can download both at https://nodejs.org/en/download/.
  2. Clone the sample application repository.
  3. Navigate to the root folder of the application in the command line.
  4. Type npm install to install required npm packages.
  5. Type npm run serve to start a development server.
  6. The application opens in your browser at http://localhost:8080.

Data origin

This sample wants to showcase either loading content from Kentico Kontent as well as load some part of the site from static JSON resources.

Basically the content that you can't find in the Localization JSON is loaded from Kentico Kontent.

  • All data loaded from Kentico Kontent are using Stores as for examples "Latest Articles" section (component here) on Home Page
  • The data provided from Localization are using vue-i18n plugin, so every call in components using $t('KEYWORD') in components is loading data from these JSONs as for example "Banner" section" (component here)

Connecting to your sample project

At the first run of the app, you'll be presented with a configuration page. It will allow you to connect the app to your Kentico Kontent sample project or create a new one. You'll also be able to start a trial and convert to a free plan when the trial expires.

Alternatively, you can connect your project manually as per the chapter below.

Connecting to your project manually

If you want to change the source Kentico Kontent project, follow these steps:

  1. In Kentico Kontent, choose Project settings from the app menu.
  2. Under Development, choose API keys.
  3. Copy your Project ID.
  4. Create and open a .env.local file in the sample application folder.
  5. On the first line, add your Project ID constant using the format VUE_APP_PROJECT_ID=00000000-0000-0000-0000-000000000000.
  6. Save the file.

When you now run the application, it will retrieve the content from your sample project. This set up has higher priority then setting your sample project by the Configuration page.

Previewing content from your project

To preview unpublished content in the sample application, follow these steps:

  1. In Kentico Kontent, choose Project settings from the app menu.
  2. Under Development, choose API keys.
  3. Copy your Project ID and Preview API key.
  4. Create and open a .env.local file in the sample application folder.
  5. On the first line, add your Project ID constant using the format VUE_APP_PROJECT_ID=00000000-0000-0000-0000-000000000000.
  6. On the next line, add your Preview API key using the format VUE_APP_PREVIEW_API_KEY=00000000-0000-0000-0000-000000000000.
  7. Save the file.

When you now run the application, you will see all project content including the unpublished version of content items.

Content administration

  1. Navigate to https://app.kontent.ai in your browser.
  2. Sign in with your credentials.
  3. Manage content in the content administration interface of your sample project.

You can learn more about content editing at Kontent Learn.

Content delivery

You can retrieve content either through the Kontent Delivery SDKs or the Kentico Kontent Delivery API:

  • For published content, use https://deliver.kontent.ai/PROJECT_ID/items.
  • For unpublished content, use https://preview-deliver.kontent.ai/PROJECT_ID/items.

For more info about the API, see the API reference.

You can find the Delivery and other SDKs at https://github.com/Kentico.

Deployment

You can use, for example, surge to deploy your app live. Check out the step-by-step guide on our blog.