Main repository with website root, tests, Docker configurations and CI configurations
Clone or download
Latest commit c54ec18 Jun 27, 2018
Permalink
Failed to load latest commit information.
.circleci
docker_conf
solrdata
web
.editorconfig
.env.example
.env.mac.example
.gitignore
.stylelintrc
CHANGELOG.md
CONTRIBUTING.md
LICENSE.txt
README.md
composer.json
composer.lock
docker-compose.yml
mac.yml

README.md

t3kit t3kit TYPO3

Starter kit for TYPO3 CMS. Tools, extensions, configurations and templates.



Development

Required dependencies:

Setup development environment:


Start using t3kit with git:

  1. git clone https://github.com/t3kit/t3kit.git

  2. cd t3kit

  3. composer install --ignore-platform-reqs

*Note: To continue with Docker you need to create docker environment .env file for your project based on an example '.env.example' or for MAC users .env.mac.example. All environments variables could be adapted to your specific needs.

  1. cp .env.example .env *or for MAC users cp .env.mac.example .env

  2. docker-compose up -d

  3. docker exec -it web /var/www/html/vendor/t3kit/db/setupdb.sh


Start using t3kit with composer:

  1. composer create-project t3kit/t3kit t3kit dev-master --keep-vcs --ignore-platform-reqs

  2. cd t3kit

*Note: To continue with Docker you need to create docker environment .env file for your project based on an example '.env.example' or for MAC users .env.mac.example. All environments variables could be adapted to your specific needs.

  1. cp .env.example .env *or for MAC users cp .env.mac.example .env

  2. docker-compose up -d

  3. docker exec -it web /var/www/html/vendor/t3kit/db/setupdb.sh

t3kit database manipulation - Setup/Restore/Pack:

  • Setup t3kit db: docker exec -it web /var/www/html/vendor/t3kit/db/setupdb.sh
  • Restore t3kit db: docker exec -it web /var/www/html/vendor/t3kit/db/restoredb.sh
  • Pack (save) t3kit db: docker exec -it web /var/www/html/vendor/t3kit/db/packdb.sh

Verify the installation:

  • Open in browser: localhost:8888 or 0.0.0.0:8888

TYPO3 backend login

The credentials for login to TYPO3´ backend are:

  • Username: admin
  • Password: admin1234

phpMyAdmin

Run phpMyAdmin docker container and connect it to t3kit:

docker run --name phpmyadmin -dp 8889:80 --network t3kit_default --rm -e PMA_HOST=t3kit_db phpmyadmin/phpmyadmin
  • t3kit_default - default docker network name based on t3kit folder name.
  • t3kit_db - default t3kit database host name (from docker-compose).

Production

Required dependencies:

Create new project based on t3kit:

composer create-project t3kit/t3kit [<directory>] [<version>] --prefer-dist --no-dev

t3kit structure

t3kit consist of three main parts plus additional extension which intended to help extend functionality for base t3kit components.

  1. t3kit - main repository with (TYPO3) website root (typo3conf, fileadmin, favicons), tests, Docker configurations and CI configurations (.circleci). t3kit repo depend on two mentioned below composer dependencies: theme_t3kit and t3kit_db.
  2. theme_t3kit - main part of t3kit conception. Theme extension based on TYPO3 Themes. It consists of new content elements, Gridelements configurations, predefined BE layouts, main menu, Solr search templates, bunch of TS configurations, Theme constants (main colors, typography, show/hide elements) and independent FE part called felayout_t3kit (JS, CSS, images, icons, components)
  3. t3kit_db default database for t3kit with configuration, page tree and examples of content elements. Also, it includes scripts to operate with DB (setup, restore, pack)
  • subtheme_t3kit_template - additional extension template which shows us an example how easily change t3kit configuration, modify templates and layouts and create new content elements.
    • There two ways how to create new t3kit subtheme based on subtheme_t3kit_template:
      • use t3kit-cli, t3kit command line interface which will automatically create new t3kit subtheme based on your needs
      • clone subtheme_t3kit_template and manually adapt it to your needs (change name, constants, configurations, content elements, templates)

t3kit versioning

  • t3kit v8 development is on master branch.
  • t3kit v7 development is on t3kit7 branch.
  • Every release synchronized with specific release of TYPO3.
  • Every release tagged by git tag using Semantic Versioning
  • Major version should be almost always the same as on TYPO3.

Example:

  • t3kit version 7.9.12

    • 7 - major version: version of TYPO3
    • 9 - minor version: new features in t3kit
    • 12 - patch version: bug fixes, documentation updates, code refactoring, new tests in t3kit
  • t3kit version 8.1.2

    • 8 - major version: version of TYPO3
    • 1 - minor version: new features in t3kit
    • 2 - patch version: bug fixes, documentation updates, code refactoring, new tests in t3kit

When we starting new major version of t3kit previous will be moved to new branch, so in this case we can keep developing new and support old one.

Examples:

  • Branch master => last t3kit release t3kit 8.1.3 = TYPO3 8.6.1
  • Branch t3kit7 => last t3kit release t3kit 7.11.3 = TYPO3 7.6.15

t3kit v7 on branch t3kit7

Previous version of t3kit v7 you can find on branch t3kit7, or you can use git tags to chose needed version:

git checkout 7.11.3
or
git checkout 7.10.0