Make sure to install the dependencies:
# yarn
yarn install
How to set up Vrtx.ContentSystem with Storyblok:
- Login to Storyblok CLI in your command line while in the project directory (make sure you have run
yarn install
first) -yarn storyblok login
- Create a new Storyblok Space -
yarn storyblok quickstart
- Grab your new storyblok space id -
yarn storyblok spaces
- Push the Vrtx.ContentSystem components to your new Storyblok space - yarn storyblok push-components --space {your-space-id} storyblok/components.vrtx.json
- Remove all the components that does not belong to vrtx.ContentSystem - yarn storyblok delete-components storyblok/components.vrtx.json --space {your-space-id} --reverse
- ???
- You are now ready to create content in Storyblok
(To update the component file, use yarn storyblok pull-components --space {your-space-id} to generate new files)
Start the development server on http://localhost:3000
yarn run dev
Build the application for production:
yarn run build
Locally preview production build:
yarn run preview
Since the home page requires some special care because of the fact that we cant have the root page have the slug "/" we need to have the slug as index.
- Create a new story with the type "Content Page".
- Name it anything.
- Put 'slug' as "index" - That way Vrtx.ContentSystem knows its the home page.
- Add content.
- Publish.
Since menu is special it needs to be of the content type 'Menu' and have the 'slug' "menu" .
- Create a new story with the type "Menu".
- Name it anything.
- Put 'slug' as "menu" - That way Vrtx.ContentSystem knows its the menu.
- Add a few departments (each department is a menu option).
- Publish.
Since footer is special it needs to be of the content type 'Menu' and have the 'slug' "footer".
- Create a new story with the type "Menu".
- Name it anything.
- Put 'slug' as "footer" - That way Vrtx.ContentSystem knows its the footer.
- Add a few departments (each department is a footer option).
- Publish.
Sometimes you might wanna create a private fork (even if the license and github don't allow it). The easiest way to create a private version is to use the template function:
The other option is to manually create a repo and add the repo as an upstream you can pull from. If you want to do that do this:
- Create an empty private repo.
- Clone the empty repo locally.
- Add Vrtx.ContentSystem repo as an upstream with:
git remote add upstream https://github.com/SebbeJohansson/Vrtx.ContentSystem.git
- Disable pushing to upstream (since you are not allowed to do that either way):
git remote set-url --push upstream DISABLE
- Pull main from the upstream:
git pull upstream/main main
- Fix any potential merge issues.
Multi-CMS version
Go to the multi-cms branch to see the older version that were prepped for multiple cmses.