storyblok

Storyblok CLI

A simple CLI for scaffolding Storyblok projects and fieldtypes.

You found an issue?
Tell us about it - open an issue or look if it was already reported.

Installation

$ npm i storyblok -g

Usage for the quickstart

$ storyblok quickstart

Usage for fieldtypes and other boilerplates

$ storyblok

What it does

We recommend to execute the quickstart command first to learn how easy it is to use Storyblok.

The CLI allows developers to get started with a new Storyblok project by answering 3 questions:

1. How should your Project be named?
2. Select the type of your project (Theme/Boilerplate/Fieldtype)
3. Select your Theme/Boilerplate (skipped for Fieldtypes)

How will it look like

Themes

• Creator Theme (Blueprint) [https://github.com/storyblok/creator-theme]
• City Theme [https://github.com/storyblok/city-theme]
• Nexo Theme [https://github.com/storyblok/nexo-theme]

Boilerplates

• PHP - Silex Boilerplate [https://github.com/storyblok/silex-boilerplate]
• JavaScript - NodeJs Boilerplate [https://github.com/storyblok/nodejs-boilerplate]
• Ruby - Sinatra Boilerplate [https://github.com/storyblok/sinatra-boilerplate]
• Python - Django Boilerplate [https://github.com/storyblok/django-boilerplate]
• JavaScript - VueJs Boilerplate [https://github.com/storyblok/vuejs-boilerplate]

Fieldtypes Development Environment

• Fieldtype [https://github.com/storyblok/storyblok-fieldtype.git]

Frequently asked questions

• What is Storyblok?
  A component composer - Storyblok augments your web framework or the technology you already use with powerful editing capabilities to bring your static websites to life. We fill the gap between a visual composer and a content collection backend system.
  
  
• How can I access the Storyblok Content Delivery API?  
  You can directly access the API using simple HTTP GET Requests. We've done some examples for you already in our Delivery APi Introduction.
  You can of course use one of the SDK's available for storyblok:
  • PHP SDK: https://github.com/storyblok/php-client
  • Ruby SDK: https://github.com/storyblok/storyblok-ruby
  • Android SDK: https://github.com/mikepenz/Storyblok-Android-SDK (Great work done by: @mikepenz)
  • more are on it's way!
    
    
• What features is storyblok capable of?
  You can find a full list of features which are available on the feature page on our website.
  
  
• I'm a developer and want to start a project with storyblok
  Glad to hear that! We've created a CLI to easily bootstrap new projects directly from the command line. You can also check out our boilerplates and themes - as well as the content delivery api itself.
  
  

Terminology

• What is a Space?
  A space is a content repository. Think of it as a place to keep all the content related to one project. Each space has its own components...
  
  
• What is a Folder?
  A folder is a collection of stories. You can create a simple structure for your content using the folders. Best examples are multilanguage/multicountry or news...
  
  
• What is a Story?
  A story is a collection of instances of components filled with information by the content creator. You will be able to fetch a story directly by its slug...
  
  
• What is a Component?
  A component is a standalone entity that is meaningful on its own. While components/bloks can be nested in each other, semantically they remain...
  
  
• What is a Field Type?
  One field type is the smallest part in the storyblok terminology...
  
  
• What is a Datasource?
  One data source is simply a collection of key-value pairs (KVP). One specific datasource-entry is a set of two linked data items: a key, which is a unique identifier...
  
  
• What is a Collaborator?
  A collaborator is a person who is explicitly a member of your project. As an owner of a space, you can choose between some roles or define...
  
  
• What is a Theme?
  If you want a hosting with our Rendering Service so you won't have to setup a server on your own you can directly choose from one of...
  
  
• What is a Boilerplate?
  If you want to use your server or have already an existing project in which you want to integrate Storyblok you can use one of ...