https://github.com/storyblok/storyblok-create-demo

Set up a modern framework app with Storyblok by running one command.
https://github.com/storyblok/storyblok-create-demo

astrobuild cli command-line-tool gatsbyjs nextjs nuxtjs product starter-kit storyblok sveltekit

Last synced: about 1 month ago
JSON representation

Set up a modern framework app with Storyblok by running one command.

• Host: GitHub
• URL: https://github.com/storyblok/storyblok-create-demo
• Owner: storyblok
• Created: 2021-07-03T11:30:09.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T17:18:22.000Z (7 months ago)
• Last Synced: 2024-10-13T00:41:17.476Z (about 1 month ago)
• Topics: astrobuild, cli, command-line-tool, gatsbyjs, nextjs, nuxtjs, product, starter-kit, storyblok, sveltekit
• Language: TypeScript
• Homepage:
• Size: 1.46 MB
• Stars: 9
• Watchers: 21
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


	

		

	

	
Create Storyblok Demo

	
A CLI to quickly start a project with your favorite framework, already set up with Storyblok, Headless CMS.
 


  
Supports

  Next.js,

  Nuxt,

  Gatsby,

  Vue,

  React,

  Astro,

  Remix,

  and SvelteKit





  

   

   

    

   

   

    

   

   



  

   

   

  

    

  


  

    

  



# Getting Started

1. Signup at https://app.storyblok.com/;

2. Create a new space and retrieve the space preview token under your space in "Settings -> Access Tokens" menu item;

3. Execute the following commands (use your preview access token when prompted when running the `npx` command):

~~~bash

npx @storyblok/create-demo@latest

cd my-app

npm i && npm run dev

~~~

4. Open the Storyblok App following the URL suggested by the output provided by the commands. It depends on the HTTPS configuration and the port used by the frameworks.

# CLI Options

The CLI has different options that can be filled, you can see all the options by running `npx @storyblok/create-demo --help`:

~~~

OPTIONS

  -d, --folder=folder                  Folder path for the demo (e.g. my-demo)

  -f, --framework=framework            Framework to use (e.g. astro)

  -h, --help                           show CLI help

  -k, --key=key                        Storyblok Access Token

  -p, --packagemanager=packagemanager  Package manager to use (yarn or npm)

  -r, --region=region                  Space region (e.g. eu-central-1, us-east-1, cn-north-1, ca-central-1, ap-southeast-2)

  -v, --version                        show CLI version

~~~

By using this, you can skip the "questions" of the CLI and fill it with your options directly like so:

~~~bash

npx @storyblok/create-demo@latest --key YOUR_STORYBLOK_PREVIEW_TOKEN --region US

~~~

### Local Development

If you want to contribute, you can run the CLI locally and test it with this command:

~~~bash

npm i

./bin/dev --key YOUR_STORYBLOK_PREVIEW_TOKEN

~~~

#### Framework Options

The framework options can be set in `src/lib/frameworks.ts` and work in combination with the [getting-started](https://github.com/storyblok/getting-started) or The Ultimate Tutorial repositories:

- `name`:  name of the framework

- `value`: cli value to use for reference

- `start`: local command to start the example

- `token`: space token used in the demo repository

- `config`: file that has the access token

- `bridge`: file that is loading the bridge

- `public`: public folder path for the static files

- `port`:  port the framework starts,

- `repositoryUrl`: (optional) the URL repository for cloning the template;

- `branch`: (optional) for setting a specific branches

- `https`: (optional) if the framework starts with https

- `submodules`: (optional) if the framework in `getting-started` is a submodule

- `tutorialLink`: (optional) - link to the framwork tutorial