Frisque StoryBlok Starter Kit Development

Sierra Vithica

Completed work

Software Engineer

Shopify Developer

Web Developer

npm

Nuxt.js

Storyblok

Computer Software

🌺 Frisque StoryBlok

Welcome to the Frisque StoryBlok starter kit! This is currently a WIP project that aims to simplify the setup of connecting NuxtJS to StoryBlok. It also aims to provide an opinionated framework and directory structure to get you going immediately.

This project contains a few default configurations out of the box such as TailwindCSS, Linting (ESLint, StyleLint, Prettier, CommitLint), Testing suite using JEST, and some NPM scripts to make development a breeze.

Some key directories and files to take a look at would be the /components directory as well as the /pages/_.vue file. The latter sets up the view and loads the proper components from the /components directory.

📓 Table of contents

✅ System Requirements

Unix-like OS (windows support is limited atm)

Node Version 14.18.3 (fermium)

NPM Version >= 6.14.5

💻 Build Setup

To get started create a .env file in the root of this project with the following information

STORYBLOK_ACCESS_TOKEN="Your Access Token Here"

For more information on how to create your StoryBlok Access Token click here.

# install dependencies
$ npm install

# serve with hot reload at localhost:3000
$ npm run dev

# build for production and launch server
$ npm run build
$ npm run start

# generate static project
$ npm run generate

# create a StoryBlok component
$ npm run create-component

# Run Linters (ESLint, StyleLint, PrettierLint)
$ npm run lint
$ npm run lint:js
$ npm run lint:style
$ npm run lint:prettier

# Run the Lint Fixer
$ npm run lintfix

# Prepare the githooks
$ npm run prepare

📂 Special Directories

You can create the following extra directories, some of which have special behaviors. Only pages is required; you can delete them if you don't want to use their functionality.

`📁 assets`

The assets directory contains your uncompiled assets such as Stylus or Sass files, images, or fonts.