In order to work on this repository on your local machine, follow these steps:
-
Install packages
Clone repository and runnpm i
to set up the Project locally. ❗Make sure you only do that when you want to work on this template, not on a project. -
Install Storyblok CLI globally
Run the following command to install the Storyblok CLI globally on your machine:npm i -g storyblok
-
Start Proxy
Run the proxy to have a preview in Storyblok
npm run proxy
-
Start the Project
Run the following command to preview the project locally on your machine:
npm run dev
If you want to create a new project based on this template please follow the detailed documentation from the docs/
folder in the following order:
docs/guides/TEMPLATE_USAGE.md
- explanation on how to work with templates.docs/guides/VERCEL.md
- connect your project to Vercel and add previews.docs/guides/TYPESCRIPT.md
- explanation on how to work with typescript with the current set up.docs/guides/SITEMAP.md
- settings for automatised sitemap.