https://github.com/riclep/laravel-storyblok
Make Laravel and Storyblok work together beautifully.
https://github.com/riclep/laravel-storyblok
content-management content-management-system headless headless-cms laravel laravel-5-package php storyblok storyblok-api storyblok-client
Last synced: 6 months ago
JSON representation
Make Laravel and Storyblok work together beautifully.
- Host: GitHub
- URL: https://github.com/riclep/laravel-storyblok
- Owner: RicLeP
- License: mit
- Created: 2019-11-13T16:31:03.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-07T12:00:50.000Z (over 1 year ago)
- Last Synced: 2024-05-07T13:25:29.241Z (over 1 year ago)
- Topics: content-management, content-management-system, headless, headless-cms, laravel, laravel-5-package, php, storyblok, storyblok-api, storyblok-client
- Language: PHP
- Homepage: https://ls.sirric.co.uk/
- Size: 482 KB
- Stars: 53
- Watchers: 3
- Forks: 15
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Use Storyblok’s amazing headless CMS with Laravel
[](https://packagist.org/packages/riclep/laravel-storyblok)
[](https://packagist.org/packages/riclep/laravel-storyblok)
[](https://scrutinizer-ci.com/g/riclep/laravel-storyblok)
[](https://scrutinizer-ci.com/g/riclep/laravel-storyblok)
[](https://ko-fi.com/M4M2C42W6)
[](https://twitter.com/intent/follow?screen_name=riclep)
This package allows you to use fantastic [Storyblok headless CMS](https://www.storyblok.com/) with the amazing [Laravel PHP framework](https://laravel.com/). It’s designed to try and feel natural to Laravel developers and part of the ecosystem whilst also converting Storyblok’s API JSON responses into something powerful with minimal effort.
### Key Features
- Pages from Storyblok mapped to PHP Pages classes giving access to the nested content (Blocks) and meta data for SEO, OpenGraph and more.
- Quickly and easily resolve relations and inverse relations between content.
- Each Storyblok component is automatically transformed into a PHP class using a simple naming convention - just match your class and component names.
- Fields in your components are converted to a Field PHP class allowing you to manipulate their data. The package automatically detects common types like richtext fields, assets and markdown. Easily cast fields to classes.
- Asset fields are converted to Assets and Image classes allowing you to manipulate them as required. Images can be easily transformed using Storyblok’s Asset CDN or external services like Imgix.
- Blocks and fields know where they sit in relation to their ancestors and [CSS classes](https://github.com/RicLeP/laravel-storyblok-css) can be created to help your styling.
- The structure of the JSON data is preserved but super powered making it simple to loop over in your views.
- It’s simple to link to the Storyblok visual composer by including one view and printing a string in a Block’s Blade template.
- Request ‘Folders’ of content such as a list of articles or a team of people complete with support for pagination.
- Richer Typography using a [supporting package](https://github.com/RicLeP/laravel-storyblok-typography) utilising PHP Typography.
## Documentation
[Read the full docs](https://ls.sirric.co.uk/docs)
[Contribute to the docs](https://github.com/RicLeP/laravel-storyblok-docs/)
## Other Packages
### Laravel Storyblok Embed
Embed all types of media in your Storyblok site using only their URL. [Package](https://github.com/RicLeP/laravel-storyblok-embed) [Docs](https://ls.sirric.co.uk/docs/2.19/embedding-media)
### Laravel Storyblok Typography
Improve your content’s typography. [Package](https://github.com/RicLeP/laravel-storyblok-typography) [Docs](https://ls.sirric.co.uk/docs/2.19/typography)
### Laravel Storyblok Layout & CSS
Helpers for layout, block positioning and CSS class name generation. [Package](https://github.com/RicLeP/laravel-storyblok-css) [Docs](https://ls.sirric.co.uk/docs/2.19/css-classes)
### Laravel Storyblok Form builder (BETA)
Build forms with Storyblok complete with Laravel’s validation. [Package](https://github.com/RicLeP/laravel-storyblok-forms) [Docs](https://ls.sirric.co.uk/docs/2.19/laravel-storyblok-forms)
### Laravel Storyblok CLI
Useful Artisan commands to help manage your content? Check out my [Laravel Storyblok CLI package](https://github.com/RicLeP/laravel-storyblok-cli)
### Testing
The tests are mostly up-to-date and cover the majority of the code. A few areas that would require hitting the Storyblok API are not tested. If you have experience mocking API please feel free to contribute tests.
### Changelog
[See it here](CHANGELOG.md)
## Contributing
Please feel free to help expand and improve this project.
### Security
If you discover any security related issues, please email ric@sirric.co.uk instead of using the issue tracker.
## Credits
- Ric Le Poidevin [GitHub](https://github.com/riclep) / [Twitter](https://twitter.com/riclep)
- [The contributors](https://github.com/RicLeP/laravel-storyblok/graphs/contributors) 😍
- [Storyblok](https://www.storyblok.com/) 😻
- [Laravel](https://laravel.com/) 🥰
- [Built and developed at U&US](https://uandus.co.uk) 💕
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
## Laravel Package Boilerplate
This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).