This is a sample website written in ASP.NET Core 3.1 that uses the Kentico Kontent Delivery .NET SDK to manage and retrieve content from Kentico Kontent. For a brief walkthrough, read Running the .NET sample app on our Developer Hub.
You can register your account for free at https://app.kontent.ai.
You can run the app in two following ways:
- Cloning the code and running it using an IDE, such as Visual Studio 2013 or later.
- Deploying the app to a new Azure App Service instance in your Azure subscription.
To run the app:
- Clone the app repository with your favorite GIT client
- For instance, you can use Visual Studio, Visual Studio Code, GitHub Desktop, etc.
- Alternatively, you can download the repo as a ZIP file, but this will not adapt the line endings in the downloaded files to your platform (Windows, Unix).
- Open the solution in your IDE (using the DancingGoat.sln file).
- Run the app.
To run the app, just click the below "Deploy to Azure" button.
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 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.
If you already have a Kentico Kontent account, you can connect this sample application to a project of your own to access its unpublished content items, and track visitors on the site. For example, you can connect the application to your version of the Sample project.
-
In Kentico Kontent, choose Project settings from the app menu.
-
Under Development, choose API keys.
- You will be copying the Project ID and API key for the Delivery Preview API.
-
Open the
\DancingGoat\appsettings.json
file. -
Use the values from your Kentico Kontent project in the
appsettings.json
file:- Project ID: Insert your project ID into the
ProjectId
configuration key. - Delivery Preview API: Create a new key named
PreviewApiKey
in theDeliveryOptions
section, and use the Delivery Preview API key as its value. To enable calls over the Delivery Preview API, you also need to add a key namedUsePreviewApi
and set it totrue
.
"DeliveryOptions": { ... "ProjectId": "YOUR_PROJECT_ID", "UsePreviewApi": true, "PreviewApiKey": "YOUR_DELIVERY_PREVIEW_API_KEY" ... },
- Project ID: Insert your project ID into the
-
Save the changes.
-
Run the application.
After you run the application, Kentico Kontent will track site visits and create new contacts when visitors submit a form. You will also be able to see all project content including the unpublished version of content items.
For more information about the integrations with the Delivery API, see the following:
- Delivery .NET SDK documentation on using the
DeliveryClient
- Navigate to https://app.kontent.ai in your browser.
- Sign in with your credentials.
- Manage content in the content administration interface of your sample project.
You can learn more about content editing with Kentico Kontent in our Help Center.
You can retrieve content either through the Kentico Kontent Delivery SDK 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 details about Kentico Kontent APIs, see our API reference. For details on how the preview functionality works in this app, see the wiki.
Content contributors sometimes need to fix errors or typos right when they see them on the website. The sample app allows users to navigate from a piece of content on the site straight to the corresponding content item or element in Kentico Kontent.
To see Edit mode in action:
- Enable Delivery Preview API by adding the following keys to the
\DancingGoat\Web.config
file:
<add key="ProjectId" value="YOUR_PROJECT_ID" />
<add key="UsePreviewApi" value="true"/>
<add key="PreviewApiKey" value="YOUR_DELIVERY_PREVIEW_API_KEY" />
- Run the app.
- Navigate to the About us section.
- Click the Edit mode switch in the bottom-left corner.
Edit buttons will appear next to each piece of content on the page.
The sample website uses adjustable images via the image transformation feature available in the Delivery API. The srcset
attribute is automatically added to the img
tag. The value of the attribute is then driven by the AppConfiguration:ResponsiveWidths appsettings.json setting. You can always disable this behavior by deleting the setting from the \DancingGoat\appsettings.json
file.
Kentico Kontent evolves over time. If you connect your sample app to an older Kentico Kontent sample project, the app may not run correctly. You can always generate the latest version of the sample Dancing Goat content project at https://app.kontent.ai/sample-project-generator . Once generated, you can either paste the new project ID to appsettings.json, or, you can navigate to your app's relative URL "/Admin/SelfConfig" and pick the new project.
Check out the contributing page to see the best places to file issues, start discussions, and begin contributing.
We would like to express our thanks to the following people who contributed and made the project possible:
Would you like to become a hero too? Pick an issue and send us a pull request!