agility / agilitycms-dotnet-starter

Agility CMS Starter for .Net

Agility CMS & .NET Starter

To start using the Agility CMS & .NET Starter, sign up for a FREE account and create a new Instance using the DotNet Starter.

Introduction to .NET and Agility CMS

About This Starter

• Uses the latest version of .NET, with greatly improved performance across many components, Language improvements to C# and F#, and much more.
• Supports full Layout Management
• Supports Preview Mode
• Includes an easy-to-use CLI tool that helps you download the Content Models from your Agility CMS instance, and generates the classes of the Content Models for you.

Tailwind CSS

This starter uses Tailwind CSS, a simple and lightweight utility-first CSS framework packed with classes that can be composed to build any design, directly in your markup.

It also comes equipped with Autoprefixer, a plugin which use the data based on current browser popularity and property support to apply CSS prefixes for you.

This project is using Node.js to generate the tailwind css classes.

Getting Started

🚨 Before you dive into the code, it's important that you have the latest version of the .NET SDK installed on your machine (>=v8.0), as the project will not run without this.

Generating/Syncing Content Models from your Agility Instance

1. cd into the Agility.NET.AgilityCLI directory.
2. Rename the App.config.example file to App.config.
3. Overwrite the values in the App.config file with the values from the API Keys page in Agility Settings.
4. Run dotnet run update preview to download the Content Models from your Agility CMS instance, and generate the classes of the Content Models for you.

Setting up the Starter

1. cd into the Agility.NET.Starter directory.
2. Rename the appsetting.json.example file to appsettings.json.
3. Overwrite the values in the appsettings.json file with the credentials from the API Keys page in Agility Settings.

Running the Site Locally

• dotnet build => Builds the website
• dotnet run => Builds & runs the website
• npm run dev & dotnet watch => Builds and runs the site in Watch mode, so changes are reflected in the browser immediately.
• dotnet clean => Cleans the build outputs of the site

How It Works

• How Pages/Layouts Work
• How Components Work
• How Layout Models/Templates Work

Deploy to Azure App Service

1. Create an Web App (server) to host your application by clicking Azure Deploy button below:
   

2. Deploy your source to Web App by following the steps here How to Deploy the Dotnet Starter to Azure

Resources

Agility CMS

• Official site
• Documentation

.NET

• Official site
• Documentation

Tailwind CSS

• Official site
• Documentation

Community

• Official Slack
• Blog
• GitHub
• Facebook
• X

Feedback and Questions

If you have feedback or questions about this starter, please use the Github Issues on this repo, join our Community Slack Channel.

agilitycms-dotnet-starter's Issues

Could not resolve Dynamic Page URL, cannot preview Blogs from CMS

The starter needs to be able to support this kind of redirect:
https://localhost:5003/posts/posts-dynamic?ContentID=124&lang=en-us&agilitypreviewkey=7MP6UIHxAnP3bMIZsUXbg4UpXhV7jUhL864YRXTtZ2yNbbWYdid1NglA9ltRsWASaUnA%2bj%2f7KMMe1XCKj1JQnQ%3d%3d&agilityts=20210702105550

This should redirect to https://localhost:5003/blog/virtual-tours-ways-to-travel-from-home in preview mode

Missing comprehensive readme

• Should list any depedencies (i.e. >=v5.0 .NET Framework SDK and Runtimes)
• Should describe how to get started with exact steps
• Should link to expanded documentation in help center
• Deployment documentation