Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 3.99 KB

README.md

File metadata and controls

80 lines (53 loc) · 3.99 KB
Raw

logo

Planty Kontent Statiq Theme

This theme can be used to create an e-commerce ready website. You'll get everything you need from products listing, categorization, FAQ, etc.

You can see it in action right here.

This theme uses Kontent headless CMS, Statiq site generator and SnipCart e-commerce.

Features

  • Product management within Kontent
  • Pages with sections
    • Sections: Hero, Header, Bullet points, Promotion, Store, Testimonials
    • Taxonomy : Tags and Categories
    • Ratings
  • SEO support: open graph & twitter cards

Getting Started

Requirements

Clone the codebase

  1. Click the "Use this template" button to create your own repository from this template.

Running locally

  • dotnet run -- preview
    • You can also emulate running the project in a virtual directory by appending --virtual-dir memoirs. See all preview options.
  • Go to http://localhost:5080/

🎊🎉 You are now ready to explore the code base!

By default, the content is loaded from a shared Kentico Kontent project. If you want to use your own clone of the project so that you can customize it and experiment with Kontent, continue to the next section.

Create a content source

  1. Go to app.kontent.ai and create an empty project

  2. Go to the "Project Settings", select API keys and copy the following keys for further reference

    • Project ID
    • Management API key

  3. Use the Template Manager UI for importing the content from content.zip file and API keys from previous step. Check Publish language variants after import option before import.

    Alternatively, you can use the Kontent Backup Manager and import data to the newly created project from content.zip file via command line:

     npm i -g @kentico/kontent-backup-manager

 kbm --action=restore --projectId=<Project ID> --apiKey=<Management API key> --zipFilename=content

    Go to your Kontent project and publish all the imported items.

  4. Map the codebase to the data source

    • adjust the DeliveryOptions:ProjectId key in appSettings.json

🚀 You are now ready to use the site with your own Kentico Kontent project as data source!

Production deployment to GitHub pages

  • Enable GitHub actions in your repo
  • Copy the .github/workflows/dotnet-core.yml to your project
  • Go to the repository secrets and set:
    • LinkRoot to the relative path of your project (e.g. /kontent-statiq-theme-planty) - this is to ensure that all links work properly when deployed to a subfolder
    • Host to the domain of your project (e.g. domain.tld) - this is to ensure that absolute links are generated where required

Customizing

  • Open appsettings.json to tweak the site name etc.
  • TODO

Credits

This was forked from the Planty e-commerce theme for Stackbit created by Snipcart, kudos to the Snip Cart team for building this.

Some images were provided by Pexels