itzbund / gsb-sitepackage
GSB 11 site package - All you need to define your GSB-11-based web project.
Requires
- itzbund/itzbund-mandatory: 1.2.3
Requires (Dev)
- codeception/codeception: 5.1.2
- codeception/module-asserts: 3.0.0
- codeception/module-db: 3.1.4
- doctrine/dbal: 3.9.3
- ergebnis/composer-normalize: 2.44.0
- friendsofphp/php-cs-fixer: 3.64.0
- helmich/typo3-typoscript-lint: 3.2.1
- itzbund/captainhook-hooks: 1.0.1
- michielroos/typo3scan: 1.7.7
- mockery/mockery: 1.6.12
- php-coveralls/php-coveralls: 2.7.0
- phpmd/phpmd: 2.15.0
- phpstan/extension-installer: 1.4.3
- phpstan/phpstan: 1.12.7
- phpstan/phpstan-phpunit: 1.4.0
- phpstan/phpstan-strict-rules: 1.6.1
- phpunit/phpunit: 10.5.37
- ramsey/conventional-commits: 1.5.1
- saschaegerer/phpstan-typo3: 1.10.2
- sbuerk/typo3-cmscomposerinstallers-testingframework-bridge: 0.1.3
- seld/jsonlint: 1.11.0
- squizlabs/php_codesniffer: 3.10.3
- ssch/typo3-rector: 2.11.0
- symfony/yaml: 7.1.5
- typo3/coding-standards: 0.8.0
- typo3/testing-framework: 8.2.3
- dev-main
- v1.7.4-rc.2
- v1.7.4-rc.1
- v1.7.3
- v1.7.3-rc.2
- v1.7.3-rc.1
- v1.7.2
- v1.7.2-rc.2
- v1.7.2-rc.1
- v1.7.1
- v1.7.1-rc.2
- v1.7.1-rc.1
- v1.7.0
- v1.7.0-rc.4
- v1.7.0-rc.3
- v1.7.0-rc.2
- v1.7.0-rc.1
- v1.6.9
- v1.6.9-rc.2
- v1.6.9-rc.1
- v1.6.8
- v1.6.8-rc.6
- v1.6.8-rc.5
- v1.6.8-rc.4
- v1.6.8-rc.3
- v1.6.8-rc.2
- v1.6.8-rc.1
- v1.6.7
- v1.6.7-rc.5
- v1.6.7-rc.4
- v1.6.7-rc.3
- v1.6.7-rc.2
- v1.6.7-rc.1
- v1.6.6
- v1.6.6-rc.5
- v1.6.6-rc.4
- v1.6.6-rc.3
- v1.6.6-rc.2
- v1.6.6-rc.1
- v1.6.5
- v1.6.5-rc.1
- v1.6.4
- v1.6.4-rc.2
- v1.6.4-rc.1
- v1.6.3
- v1.6.3-rc.3
- v1.6.3-rc.2
- v1.6.3-rc.1
- v1.6.2
- v1.6.2-rc.6
- v1.6.2-rc.5
- v1.6.2-rc.4
- v1.6.2-rc.3
- v1.6.2-rc.2
- v1.6.2-rc.1
- v1.6.1
- v1.6.1-rc.11
- v1.6.1-rc.10
- v1.6.1-rc.9
- v1.6.1-rc.8
- v1.6.1-rc.7
- v1.6.1-rc.6
- v1.6.1-rc.5
- v1.6.1-rc.4
- v1.6.1-rc.3
- v1.6.1-rc.2
- v1.6.1-rc.1
- v1.6.0
- v1.6.0-rc.12
- v1.6.0-rc.11
- v1.6.0-rc.10
- v1.6.0-rc.9
- v1.6.0-rc.8
- v1.6.0-rc.7
- v1.6.0-rc.6
- v1.6.0-rc.5
- v1.6.0-rc.4
- v1.6.0-rc.3
- v1.6.0-rc.2
- v1.6.0-rc.1
- v1.5.1
- v1.5.1-rc.4
- v1.5.1-rc.3
- v1.5.1-rc.2
- v1.5.1-rc.1
- v1.5.0
- v1.5.0-rc.4
- v1.5.0-rc.3
- v1.5.0-rc.2
- v1.5.0-rc.1
- v1.4.2-rc.1
- v1.4.1
- v1.4.1-rc.14
- v1.4.1-rc.13
- v1.4.1-rc.12
- v1.4.1-rc.11
- v1.4.1-rc.10
- v1.4.1-rc.9
- v1.4.1-rc.8
- v1.4.1-rc.7
- v1.4.1-rc.6
- v1.4.1-rc.5
- v1.4.1-rc.4
- v1.4.1-rc.3
- v1.4.1-rc.2
- v1.4.1-rc.1
- v1.4.0
- v1.4.0-rc.11
- v1.4.0-rc.10
- v1.4.0-rc.9
- v1.4.0-rc.8
- v1.4.0-rc.7
- v1.4.0-rc.6
- v1.4.0-rc.5
- v1.4.0-rc.4
- v1.4.0-rc.3
- v1.4.0-rc.2
- v1.4.0-rc.1
- v1.3.0
- v1.2.0
- v1.2.0-rc.1
- v1.1.1-rc.1
- v1.1.0
- dev-release
This package is auto-updated.
Last update: 2024-10-26 04:33:04 UTC
README
<img src="https://produkt.gsb.bund.de/SiteGlobals/Frontend/Images/logo.png?__blob=normal&v=1" alt="Logo" width="300">
GSB 11 Sitepackage Kickstarter
Jumpstart your GSB 11 powered tenant development.
<br>
<br>
<a href="https://demo.gsb-itzbund.de/">See the Demo</a>
<small><small>(you'll need a username & password)</small></small>
About
The GSB Sitepackage Kickstarter will help you to get started with GSB 11 tenant development. After completing the steps below, you will have a local development environment with sample content up and running. You will be able to commit your tenant configuration and development to your tenant GitLab repository.
Tenant Factsheet
Please have a first look into the Tenant Factsheet upfront and use it as a reference for all questions regarding your tenant GSB 11 project.
Prerequisites
You need a few things upfront:
- ddev installed on your computer
- php version 8.2 installed on your computer including the required extensions
- composer installed on your computer
- Login details (Username, Password) to GSB 11 GitLab or OpenCoDE
- (GSB 11 GitLab only) Deploy token (Username, Password) to GSB 11 GitLab
- (GSB 11 GitLab only) SSH key setup to communicate with GitLab
- (GSB 11 GitLab only / tenant development only) Git remote address for your own tenant sitepackage Git repository
Preparation if you use OpenCoDE
Authenticate with OpenCoDE
composer config -g gitlab-domains gitlab.opencode.de composer config -g repositories.gsb-sitepackage vcs https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb-sitepackage-kickstarter.git composer config -g repositories.a11y-backend vcs https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/a11y_backend.git composer config -g repositories.captainhook-hooks vcs https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/captainhook-hooks.git composer config -g repositories.gsb-core vcs https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb_core.git composer config -g repositories.gsb-feusermanagement vcs https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb_feusermanagement.git composer config -g repositories.gsb-metadata-cleaner vcs https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb_metadata_cleaner.git composer config -g repositories.gsb-widgets vcs https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb_widgets.git
Set user and password (use your personal access token as password)
composer config -g gitlab-token.gitlab.opencode.de <PASSWORD>
Preparation if you use git.gsb-itzbund.de
Authenticate with GSB 11 GitLab
composer config -g gitlab-domains git.gsb-itzbund.de composer config -g repositories.63 composer https://git.gsb-itzbund.de/api/v4/group/63/-/packages/composer/packages.json
Set user and password
composer config -g gitlab-token.git.gsb-itzbund.de <PASSWORD>
Installation
NOTE
We use Linux and macOS in our team, so the Windows setup may not work without errors.
If you are developing on Windows, use ddev in WSL2 and enter the following commands in the Linux shell.
If you notice an error, please contribute your solution.
Follow the steps to set up a GSB 11 website with this sitepackage as a composer root package.
Create GSB 11 project
composer create-project itzbund/gsb-sitepackage gsb11-mandant && cd gsb11-mandant
If this command fails, try this workaround.
cd gsb11-mandant composer config --unset repositories.63 composer install
OR remove the folowing from the composer.json
"repositories": { "63": { "type": "composer", "url": "https://git.gsb-itzbund.de/api/v4/group/63/-/packages/composer/packages.json" } } than run composer install
Start local development environment
ddev start
GSB 11 GitLab only! Add Additional Extension
Template including "Styleguide des Bundes"
composer require itzbund/gsb-frontend
Demo Content
composer require itzbund/gsb-distribution
Install GSB 11
ddev exec cp .composer/vendor/typo3/cms-install/Resources/Private/FolderStructureTemplateFiles/root-htaccess .build/public/.htaccess && \ ddev exec .composer/bin/typo3 setup --force \ --no-interaction \ --server-type=apache \ --driver=mysqli \ --username=db \ --password=db \ --port=3306 \ --host=db \ --dbname=db \ --admin-username=admin \ --admin-user-password=Pas§§wor1 \ --admin-email='' \ --project-name="GSB11" \ --create-site="https://gsb-sitepackage.ddev.site"
NOTICE: This configuration is used exclusively in the local development environment. The configuration is discarded in the deployment process! Please use a secure password
Install extensions
ddev exec .composer/bin/typo3 extension:setup
GSB 11 GitLab only! (optional) You can remove the Distribution Extension. The dummy content (page tree and files) is already loaded. The extension is now obsolete.
ddev composer remove itzbund/gsb-distribution
Launch project
ddev launch
Login Backend
Visit https://gsb-sitepackage.ddev.site/typo3 in your browser or use the
ddev launch /typo3
NOTICE: You defined Username and Password in step 4 "Install GSB 11".
GSB 11 GitLab only! Initialize Git and add remote repository
git init --initial-branch=main git remote add origin https://git.gsb-itzbund.de/gsb11/sitepackages/<NAME OF YOUR TENANT SITEPACKAGE REPOSITORY> git add . git commit -m "Initial commit" git push --set-upstream origin main
Configure your GSB 11 tenant 🚀
Notes
For further information, please refer to the readmes of the extensions. A list of available extensions is included in the Mandate Factsheet.
Development
Explanations about caching in GSB 11 and the CI/CD pipelines in development are stored in the GSB 11 GitLab documentation project.
To successfully release a mandate version of GSB 11, the site package must be developed with trunk-based development, with main
being the standard branch. A merge into release
triggers a stable release. The branches main
and release
are mandatory.
Contribute
As with TYPO3, we encourage you to join the project by submitting changes. Development of the GSB 11 happens mainly in the GSB 11 TYPO3 extensions.
To get started, have a look at our detailed contribution walkthrough.