riconet/t3-project-skeleton

This project contains a skeleton for a TYPO3 projects.

10.4.11 2021-10-04 14:18 UTC

README

Need to know

This project is not tested under windows.

Description

This composer project was created, to ease the process of creating a new TYPO3 Project. This setup contains the commonly used files and folders, to get started and a development environment, based on docker.

How to create a new project / How to use this project

Open your shell and navigate to the destination of your upcoming extension. Execute the following command and remember to define a name for your extension.

composer create-project "riconet/t3-project-skeleton:9.5.*" PROJECT_NAME

inside the folder

git clone https://git.riconnect.de/riconet-public/typo3/rico_templates.git app/extensions/rico_templates_PROJECT_NAME

cd app/extensions/rico_templates_PROJECT_NAME
rm -rf .git

find . -type f -not -path '*/\.*' -exec sed -i '' 's/tx_ricotemplates/tx_ricotemplates_PROJECT_NAME/g' {} +
find . -type f -not -path '*/\.*' -exec sed -i '' 's/rico_templates/rico_templates_PROJECT_NAME/g' {} +
find . -type f -not -path '*/\.*' -exec sed -i '' 's/RicoTemplates/RicoTemplatesProjectname/g' {} +
sed -i '' 's/t3-internal-extension-templates/t3-internal-extension-templates-PROJECT_NAME/g' composer.json

add to typo3 composer.json

"riconet/t3-internal-extension-templates-PROJECT_NAME": "@dev",

Installation

After you´ve run the `composer create-project ...` command, navigate in the root of the newly create project and run the following command:

bin/init.sh

This will install a fresh TYPO3 and start the containers. You have to do this only once, next time, if you want to start the containers, run docker-compose up and to stop them run docker-compose down.

Info

Scripts

This project comes with some scripts, to ease the work, with this configuration. You can find them in `bin`.

All scripts are written for linux/mac os (.sh) and windows (.bat).

file (.sh / .bat)Description
initInitializes a fresh TYPO3 instance.
clear-cacheClears the cache of your TYPO3
update-composerUpdates composer.
update-databaseUpdates the database schema.

Admin user

FieldValue
usernameadmin
password12345678

Database

FieldValue
databaseapplication
hostdb
useruser
password3306
port3306

composer.json in app folder

Don't forget to change the values 'name' and 'description' to the proper values for the customer.

Import SQL in to the docker container.

cat FILENAME.sql | docker exec -i db /usr/bin/mysql -u root --password=1234 application

Tests

Acceptance

This kind of tests requires a running web server, reachable local (http://127.0.0.1) and a running selenium server, also reachable local (http://127.0.0.1:4444/wd/hub).

If you use the shipped docker-compose file for local development, this is already setup for you.

You can find more information, on failed test, under `test/app/tests/_output`.

Requirements

  • A local web server, accessible under localhost.
  • A local selenium server, accessible under localhost.

Run acceptance test suite

build/scripts/console.sh -s acceptance

Acceptance - Side files

Selenium gives you the possibility, to record your behavior on a page. This records are stores as .side files.

If you want to run those files, store them under `test/app/tests/Acceptance/Sides`.

You can find more information, on failed test, under `test/app/tests/_output`.

Requirements

  • A local web server, accessible under localhost.
  • A local selenium server, accessible under localhost.
  • Program selenium-side-runner installed on your system.

Run .side files

build/scripts/console.sh -s side-runner