Storyblok Exporter

A Drupal module that provides a Drush command to export blog articles and migrate content to Storyblok.

Overview

The Storyblok Exporter module allows you to export Drupal blog articles to the Storyblok content management system as reusable components. This can be useful for building decoupled applications that consume content from multiple sources, including Drupal.

Note: This is a proof-of-concept module and should not be used in production environments.

Requirements

• Drupal 10+
• Drush 9+
• Storyblok Management API PHP SDK (storyblok/php-management-api-client)
• A Storyblok account with a Space and a Personal access token

Drupal Installation

I recommend using ddev for local development, which is based on Docker.

ddev Installation

• If you don't have a local Docker provider, install it.
• Install ddev

Drupal installation with ddev

Use the following commands:

mkdir my-drupal-site && cd my-drupal-site
ddev config --project-type=drupal --php-version=8.3 --docroot=web
ddev start
ddev composer create drupal/recommended-project:^11
ddev composer require drush/drush
ddev config --update
ddev restart
ddev drush site:install --account-name=admin --account-pass=admin -y
ddev launch
# or automatically log in with
ddev launch $(ddev drush uli)

Installation

1. Install the Storyblok Management API SDK

First, add the Storyblok Management API SDK to your project:

$ [ddev] composer require storyblok/php-management-api-client

2. Install the Module

Download or clone this repository into your Drupal module directory (e.g., /path/to/drupal/web/modules/).

Enable the module by running:

$ [ddev] drush en storyblok_exporter

Or through the Drupal admin interface.

Module Usage

In Storyblok, create a new Space and take note of the Space ID.

Then create a Block of type Content type named article with the following fields:

• title: Text
• body: Richtext
• image: Asset

Note: It's required to have these exact field names and types because the mapping is currently fixed in the code.

Set your Storyblok Personal access token and the Space ID in your settings.local.php. If this is a fresh Drupal installation, go to web/sites/default/settings.php, uncomment the last lines, and then create a settings.local.php in the same folder with the following content:

$settings['STORYBLOK_OAUTH_TOKEN'] = 'your-oauth-token'; // this is the Personal access token (in Account settings in Storyblok)
$settings['STORYBLOK_SPACE_ID'] = 'your-space-id'; // this is the ID of your Space (no #)

In Drupal, create some content of type article, fill all the fields with some content.

Finally, run the Drush command from the command-line:

$ [ddev] drush storyblok_exporter:export

Or you can use the short alias:

$ [ddev] drush sbe

There are some options for the command, check the command help.

If everything is correct, you should see something similar to the following output:

$ [ddev] drush storyblok_exporter:export
Uploading image: drupal.jpg
Successfully uploaded image: drupal.jpg
Creating tags: Drupal, CMS
Successfully created tag: Drupal
Successfully created tag: CMS
Successfully migrated: Drupal is an open source CMS
Uploading image: astro-cover.webp
Successfully uploaded image: astro-cover.webp
Creating tags: Storyblok, Astro
Successfully created tag: Storyblok
Successfully created tag: Astro
Successfully migrated: I am switching to Storyblok and Astro
 [success] Exported 2 articles to Storyblok.
 [success] Content succesfully exported 🎉

The exported articles will be available as Stories in your Space, and you will find the attached images in your Asset Library.

Contributing

Contributions are welcome! Please open an issue or submit a pull request if you have any improvements or bug fixes.

License

This project is licensed under the MIT License.