Download the PHP package pieceofcake2/storybook without Composer
On this page you can find all versions of the php package pieceofcake2/storybook. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pieceofcake2/storybook
More information about pieceofcake2/storybook
Files in pieceofcake2/storybook
Package storybook
Short Description Storybook for CakePHP 2 (development only): render Elements in Storybook (Vite), inspired by Storybook for Symfony
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package storybook
Storybook for CakePHP 2
pieceofcake2/storybook renders the Elements of a CakePHP 2 application in Storybook. It is inspired by Storybook for Symfony. A story names an Element and its args, Storybook sends them to the application, and the application renders the Element with its own View class and helpers.
It consists of a CakePHP plugin, which provides the render endpoint (POST /_storybook/render),
and a Storybook framework that uses Vite (@pieceofcake2/storybook, included in the Composer
package).
[!IMPORTANT] This plugin is for development only. Install it as a dev dependency (
composer require --dev), and never install it in production. The render endpoint works only in debug mode.
Documentation
- Website: https://pieceofcake2.github.io/storybook/ (日本語: https://pieceofcake2.github.io/storybook/ja/)
- Markdown: docs/ja/README.md) (for AI tools and offline reading)
The Markdown documentation is also included in the Composer package, in the plugin's directory: plugins/Storybook/docs/README.md (the location depends on your installer-paths).
Requirements
- PHP 8.0+
- pieceofcake2/cakephp 2.12+
- Node.js 20.19+, Storybook 10 and Vite 5 to 8
- To publish a static Storybook:
playwright-coreand Chrome or Chromium
Installation
Then load the plugin with its routes when it is installed, and configure .storybook/main.ts. See
Installation.
Develop the stories with storybook dev and the application running in debug mode. To publish
Storybook (e.g. on a development server running with debug 0 and without the plugin), pre-render
the stories into a static build, which does not request the application:
See Publishing a Static Storybook.
Security
Only the name of an Element (under the allowed directories, Elements/components/ by default) and
its args are sent to the application, never a template or code. The render endpoint exists only
where the plugin is installed, and only in debug mode: production is deployed with
composer install --no-dev, so it does not have the plugin. See Security and
Keeping Storybook out of Production.
Contributing
See the contribution guidelines.
The Storybook framework is in storybook/. Its build (storybook/dist/)
is committed, since applications install it from the Composer package without building it.
Origin
This package was created by pieceofcake2, which also maintains it. It is inspired by Storybook for Symfony, and parts of the Storybook framework are adapted from it (MIT License, Copyright (c) 2024 SensioLabs). See storybook/NOTICE.md.
License
MIT License. See LICENSE.
All versions of storybook with dependencies
composer/installers Version ^1.0 || ^2.0
pieceofcake2/cakephp Version ^2.12