⚠️ DEPRECATION NOTICE ⚠️

This template repository (custom-app-examples) is deprecated and no longer actively maintained or recommended.

Please refer to the new central repository, storyblok/space-tool-plugins, for examples, boilerplates, and the standard approach to developing Space Plugins (or Tool Plugins) for Storyblok. This new location provides updated resources and represents the standard going forward.

• ➡️ New Space Plugin projects should use the resources found in storyblok/space-tool-plugins.
• ➡️ Existing projects based on this template should refer to storyblok/space-tool-plugins for updates and best practices.

Find the new resources here:

• GitHub: https://github.com/storyblok/space-tool-plugins
• Tool plugins documentation: https://www.storyblok.com/docs/plugins/tool-plugins
• Space plugins documentation: https://www.storyblok.com/docs/plugins/space-plugins

Thank you for your understanding.

Custom Apps Examples

A collection of custom apps for Storyblok created by the community. Read more about creating custom apps here. Custom apps can be built by any partner. Read more about our partners and how to become one of them here.

• Next.js starter
• Nuxt.js starter (Work in progress)

Table of Content

• Example Repositories
• Contributing

Example Repositories

The following examples live in their own Github repository.

Example	Author
Storyblok Workflow App A Storyblok custom app for managing workflow stages	storyblok

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 custom app

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

Name	Description	Author
Name of your custom app	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. ⚡️