storyblok/tool-examples

A collection of tools to use with Storyblok by the community

Tool Examples

A collection of tools & scripts for Storyblok created by the community.

Table of Content

• Examples
• Example Repositories
• Contributing

Examples

Each example contains a README.md with an explanation about the tool.

Example	Author
Clean Up Field Script A tool to remove a specific field from all stories	Alexander Feiglstorfer
Clone Assets A tool to clone assets from a space to its clone	Christian Zoppi
Storyblok Private Asset Demo Repository to showcase a typical use case for Storyblok private assets.	Edoardo Sandon
Storyblok Assets Backup Tool for differential backups of the assets of any Storyblok space	Christian Zoppi, Gerrit Plehn
Storyblok Unused Assets Detect unused assets and either move them to a folder or delete them.	Christian Zoppi, Alexandra Spalato

Example Repositories

The following examples live in their own Github repository.

Example	Author
React Rich Text Renderer For Storyblok In Built Rte Renderer to outputs React elements, and provides options to map any Stoyblok rich text element to custom React components	dohomi
Storyblok Generate Component Typings NodeJS tool to auto generate TypeScript types based on your components.x.json file	dohomi
Storyblok Migrate Migration tool from Storyblok (Import/Export of schemas and content)	maoberlehner
Sb Mig CLI tool to handle migrations and components in Storyblok	sb-mig

Contributing

Have an example? Submit a PR or open an issue.We are happy to accept more examples from the community.

Adding an example in this repository

1. Create a new folder for your tool

2. Add a README.md file in your example folder with a markdown table of the following format:

Name	Description	Author
Name of your tool	Short description	Your Github

3. Make sure your contribution matches the linting setup for this repo:

Run the linting via

npm run lint

4. Regenerate the README.md with the following command

npm run docs

5. Open a new pull request with your example. ⚡️

Adding an example in a different repository

If you want to be listed in the Example Repositories, follow these steps:

1. Create a new entry with a name, description, and githubUrl in the community-examples.json file.

2. Regenerate the README.md with the following command

npm run docs

3. Open a new pull request with your example.

tool-examples's Issues

Backup all assets as zip file into S3

We want to backup all assets as zip file into S3 storage.
If we use current implementation assets could be overwritten.
We want be able to restore assets from backup in time.

Assets not copied over to target space even though the CLI terminates with success

Hi there,

Firstly, thank you so much for providing this CLI. It's quite handy.

I've run the script, ensuring that my personal access token is correct along with the space ID of the source/target.

The CLI runs and terminates successfully, however, the assets are not copied/cloned over to the target space as it should.

Was wondering why that's the case. Can you please advice?

Storyblok asset manager of the target space

Log of the Script

Also, I'm not quite sure whether the issue lies within the CLI itself or from my end, but the CLI terminates with an error due to the following 2 lines (which I comment it out for me to bypass the issue):

Cloned assets are imported without their folders

I used the clone-assets tool, which successfully cloned all of the assets from one space to another, but the folders from the original space did not get copied over.

---

Expected Behavior

I would expect the folder relationships to be retained in the new space. When you have thousands of assets, the organization is important for a good user experience.

Current Behavior

Assets are cloned without their folders.

Steps to Reproduce

1. Use the clone-assets tool on a space where assets are organized into folders.
2. After the import, check the new space and you will see the folders are missing.