https://github.com/friendsoftypo3headless/headless_bootstrap_package

Provides JSON output to EXT:bootstrap_package content elements
https://github.com/friendsoftypo3headless/headless_bootstrap_package

bootstrap bootstrap-package extension php typo3 typo3-cms-extension typo3-extension

Last synced: 12 months ago
JSON representation

Provides JSON output to EXT:bootstrap_package content elements

• Host: GitHub
• URL: https://github.com/friendsoftypo3headless/headless_bootstrap_package
• Owner: FriendsOfTYPO3Headless
• License: gpl-2.0
• Created: 2022-02-02T15:43:40.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-02-14T19:46:48.000Z (over 2 years ago)
• Last Synced: 2024-03-14T21:05:24.517Z (over 2 years ago)
• Topics: bootstrap, bootstrap-package, extension, php, typo3, typo3-cms-extension, typo3-extension
• Language: PHP
• Homepage:
• Size: 729 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)

[![TYPO3 11](https://img.shields.io/badge/TYPO3-11-orange.svg)](https://get.typo3.org/version/11)

[![TYPO3 12](https://img.shields.io/badge/TYPO3-12-orange.svg)](https://get.typo3.org/version/12)

[![TYPO3 13](https://img.shields.io/badge/TYPO3-13-orange.svg)](https://get.typo3.org/version/13)

[![Latest Stable Version](http://poser.pugx.org/friendsoftypo3headless/headless-bootstrap-package/v)](https://packagist.org/packages/friendsoftypo3headless/headless-bootstrap-package)

[![Total Downloads](http://poser.pugx.org/friendsoftypo3headless/headless-bootstrap-package/downloads)](https://packagist.org/packages/friendsoftypo3headless/headless-bootstrap-package)

[![Latest Unstable Version](http://poser.pugx.org/friendsoftypo3headless/headless-bootstrap-package/v/unstable)](https://packagist.org/packages/friendsoftypo3headless/headless-bootstrap-package)

[![License](http://poser.pugx.org/friendsoftypo3headless/headless-bootstrap-package/license)](https://packagist.org/packages/friendsoftypo3headless/headless-bootstrap-package)

[![PHP Version Require](http://poser.pugx.org/friendsoftypo3headless/headless-bootstrap-package/require/php)](https://packagist.org/packages/friendsoftypo3headless/headless-bootstrap-package)

# TYPO3 Extension "headless_bootstrap_package" - Provides TypoScript definitions for proper JSON output from EXT:bootstrap_package content elements and configuration

This extension provides integration

for [EXT:bootstrap_package](https://github.com/benjaminkott/bootstrap_package)

with [EXT:headless](https://github.com/TYPO3-Headless/headless).

It provides TypoScript rendering definitions for all of EXT:bootstrap_packages

ContentElements to output them as proper JSON.

## Requirements

This Extension requires:

- [TYPO3](https://github.com/TYPO3) in version at least 11.5

- [EXT:headless](https://github.com/TYPO3-Headless/headless) in version at least

  3.0.3

- [EXT:bk2k/bootstrap-package](https://github.com/benjaminkott/bootstrap_package)

  in version at least 12.0

## TYPO3 Installation

Install extension using composer\

``composer require friendsoftypo3headless/headless-bootstrap-package``

and then, include TypoScript template, and you are ready to go.

**Important**: Do **NOT** include the Setup/Constants provided by EXT:

bootstrap_package since they would interfere with the EXT:headless page

config. 



Instead please include the provided "Headless Boostrap Package: Boostrap Package

Constants" TypoScript config in order to gain access to the EXT:

bootstrap_package constants.

This extension adds a "bootstrapPackage" key to every JSON page reponse

containing the EXT:bootstrap_package constants/config:

![BootstrapPackageConstants](./Documentation/assets/bootstrapPackageConstants.png)

It also merges the page.meta constants into the page.meta JSON array:

![pageMetaData](./Documentation/assets/pageMetaData.png)

## Testing

This Extension comes with a phpunit testsuite with functional tests for all

content elements.


To run the tests simply use the provided composer script:

```composer ci:test```

## Credits

A special thanks goes

to [TRIXIE Heimtierbedarf GmbH & Co. KG](https://www.trixie.de), which is

sponsoring development of this extension.

## Developers involved in the project

- [Sven Petersen](https://github.com/svenpet90) ([DAUSKONZEPT GmbH](https:///www.dauskonzept.de) && [HardAnders GbR](https://www.hardanders.de))

- [Niels Seelhöfer](https://github.com/derseeli) ([TRIXIE Heimtierbedarf GmbH & Co. KG](https://www.trixie.de) && [Datenanker](https://www.datenanker.com))