t3g/mainzific-rim

Mainz in Danger - the site package for SkillDisplays gamification adventure for ongoing TYPO3 CMS certified editors

2.0.6 2020-08-07 10:12 UTC

Requires

• bk2k/bootstrap-package: ^10.0
• georgringer/news: ^7.0
• typo3/cms-adminpanel: ^9.5
• typo3/cms-backend: ^9.5
• typo3/cms-belog: ^9.5
• typo3/cms-beuser: ^9.5
• typo3/cms-core: ^9.5
• typo3/cms-felogin: ^9.5
• typo3/cms-filelist: ^9.5
• typo3/cms-form: ^9.5
• typo3/cms-recordlist: ^9.5
• typo3/cms-redirects: ^9.5
• typo3/cms-seo: ^9.5
• typo3/cms-setup: ^9.5
• typo3/cms-tstemplate: ^9.5

Requires (Dev)

• bk2k/extension-helper: ^1.0

GPL-2.0-or-later

• TYPO3 CMS
• SkillDisplay
• TCCE

README

Site package for the project "Mainzific Rim"

The package serves as a base for TYPO3 9 LTS sites used in the Mainzific Rim adventure. Young students solve missions in order to save Mainz from a Dino attack and become Certified TYPO3 editors doing so.

The package contains

• the bootstrap package as base for FE output
• the news extension
• an image in fileadmin to start with
• initial content (pages, content elements, necessary sys-folders)
• a preconfigured BE usergroup designed for editors
• a BE user (editor:editor) that uses the group and serves as start
• a BE user (news_editor:news_editor) that has news edition permissions preconfigured
• a BE user (bob.bernsteiner:you_must_not_forget_your_password) that is a base for one of the missions
• a BE user (root:root) that is an admin user
• a preconfigured BE usergroup designed for news editors

How to install

The easy way (from scratch): All you need is a directory where the doc root for the server configuration can be configured. From command line, execute the composer require command on an empty composer.json.

composer require t3g/mainzific-rim

The preconfigured requirements of the site package will provide you with a ready made TYPO3 installation that just needs installation via Install Tool.

The long way (also usable if you want to include the package into on existing setup, but please note that the data import will truncate most of the key tables!):

1. Set up a TYPO3 instance as usual.
2. Include the extension (via composer or download).
3. Go to Extension Manager and activate the extension.

   Note: Bootstrap_package and news get activated, too. No single activation needed.

4. When you get logged out, use the user root:root to gain login immediately.
5. Recreate your own root user or change the password for root.

   Note: Do the one or the other, don't leave the temporary user active!

⚠️ Site configuration is necessary for multi-language to work - see below for instructions!

Note:

💡 Since TYPO3 v9, you will need to provide a site configuration for human readable URLs and working language menu out of the box. Since the core is not yet ready to get a site configuration injected with a site package, please find an example configuration that works nicely with this package in ext:mainzific_rim/Configuration/sites/. No error handling is configured, though.

In a composer based installation, create a folder config/ in your instance root (same level as public/). In a traditional installation, create a folder config/ inside of the typo3conf/ folder. Copy the whole sites/ folder from ext:mainzific_rim/Configuration/ into this newly created config/ folder.

Troubleshooting: If your copied sites configuration will not be accepted by TYPO3 (check inside the sites module in BE), you can have TYPO3 create a site config. Just fill in the form so far it gets accepted for submission. Then, check in the files where the config/ folder ended up. Then, override the config.yaml with the one from ext:mainzific_rim.