mirror of https://github.com/FriendsOfTYPO3/tea.git synced 2024-09-19 18:36:12 +02:00

Compare commits

...

2 commits

Author SHA1 Message Date
Felix Althaus
cd6df41eb7
[TASK] Rename npm commands to fit general naming scheme (#1404) 2024-07-30 19:44:41 +02:00
Eike Starkmann
8e592adba7
[TASK] Add more development documentation (#1399)
Resolves:  #1393
2024-07-30 17:41:28 +00:00
4 changed files with 70 additions and 7 deletions

View file

@ -102,7 +102,7 @@ jobs:
npm ci
- name: "Run command"
run: |
npm run lint:${{ matrix.command }}
npm run ci:lint:${{ matrix.command }}
unit-tests:
name: "Unit tests"
runs-on: ubuntu-24.04

View file

@ -2,10 +2,10 @@ javascript-lint:
extends: .default-frontend
stage: lint
script:
- npm run lint:js
- npm run ci:lint:js
style-lint:
extends: .default-frontend
stage: lint
script:
- npm run lint:style
- npm run ci:lint:style

View file

@ -8,3 +8,66 @@ 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 <https://github.com/oliverklee/TYPO3-testing-distribution/>`__
by Oliver Klee as development environment. The distribution comes with a frontend,
example data and predefined plugins.
.. index:: Clone TYPO3 Testing Distribution
.. code-block:: bash
git clone git@github.com:oliverklee/TYPO3-testing-distribution.git
Also clone the tea extension.
.. index:: Clone Tea Extension
.. code-block:: bash
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:
.. index:: Folder structure
.. code-block:: bash
git\
TYPO3-testing-distribution
tea
Inside the testing distribution there is a file
:file:`docker-compose.extensions.yaml.template` which mounts the used extensions. This file need to be renamed and adjusted.
.. index:: Create docker-compose.extensions.yaml
.. code-block:: bash
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.
.. index:: Mount extension into testing distribution
.. code-block:: yaml
services:
web:
volumes:
- "$HOME/git/tea:/var/www/html/src/extensions/tea:cached,ro"
After that you can start the testing distribution using ddev.
.. index:: Start the testing distribution
.. code-block:: bash
ddev start
ddev composer install
ddev install-typo3
ddev db-import
After that you should be able to access the frontend:
.. code-block:: bash
ddev launch

View file

@ -14,10 +14,10 @@
"npm": "^10.5.0"
},
"scripts": {
"lint:js": "eslint 'Resources/Public/**/*.js'",
"lint:js:fix": "eslint 'Resources/Public/**/*.js' --quiet --fix",
"lint:style": "stylelint Resources/Public/**/*.css",
"lint:style:fix": "stylelint Resources/Public/**/*.css --fix"
"ci:lint:js": "eslint 'Resources/Public/**/*.js'",
"fix:lint:js": "eslint 'Resources/Public/**/*.js' --quiet --fix",
"ci:lint:style": "stylelint Resources/Public/**/*.css",
"fix:lint:style": "stylelint Resources/Public/**/*.css --fix"
},
"devDependencies": {
"eslint": "^9.2.0",