danielsiepmann/tea
danielsiepmann/tea
1
0
mirror of https://github.com/FriendsOfTYPO3/tea.git synced 2024-11-25 08:56:12 +01:00
Code Activity
tea/Documentation/Environment.rst
Daniel Siepmann 5986b09e81
[BUGFIX] Broken rendering in docs (#1428) 
Add necessary blank line.
The indentation will be rendered as quote otherwise.
2024-08-20 08:51:16 +02:00

1.9 KiB
Raw Blame History

Development environment

You can run the code quality checks and automated tests locally (using a local PHP, Composer, and database) or using runTests.sh.

To kickstart the project, we suggest the usage of the TYPO3-testing-distribution by Oliver Klee as development environment. The distribution comes with a frontend, example data and predefined plugins.

Clone TYPO3 Testing Distribution

git clone git@github.com:oliverklee/TYPO3-testing-distribution.git

Also clone the tea extension.

Clone Tea Extension

git clone git@github.com:FriendsOfTYPO3/tea.git

You can organize the folder structure as you wish, but lets say your folder structure looks like this:

Folder structure

git\
    TYPO3-testing-distribution
    tea

Inside the testing distribution there is a file docker-compose.extensions.yaml.template which mounts the used extensions. This file need to be renamed and adjusted.

Create docker-compose.extensions.yaml

cp .ddev/docker-compose.extensions.yaml.template .ddev/docker-compose.extensions.yaml

The file needs to mount the tea extension into the testing distribution. Keep in mind that you use the correct paths here.

Mount extension into testing distribution

services:
  web:
    volumes:
      - "$HOME/git/tea:/var/www/html/src/extensions/tea:cached,ro"

After that you can start the testing distribution using ddev.

Start the testing distribution

ddev start
ddev composer install
ddev install-typo3
ddev db-import

After that you should be able to access the frontend:

ddev launch