PHPackages t3kit/t3kit-starter - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [DevOps & Deployment](/categories/devops) 4. / 5. t3kit/t3kit-starter ActiveProject[DevOps & Deployment](/categories/devops) t3kit/t3kit-starter =================== Starter point for t3kit project. t3kit and TYPO3 dependencies, folder structure, custom site configurations, local environment based on Docker, CI/CD configs 11.1.2(2y ago)34204[7 issues](https://github.com/t3kit/t3kit-starter/issues)GPL-2.0-or-laterCSSCI failing Since Aug 17Pushed 2y ago6 watchersCompare [ Source](https://github.com/t3kit/t3kit-starter)[ Packagist](https://packagist.org/packages/t3kit/t3kit-starter)[ Docs](http://t3kit.com)[ RSS](/packages/t3kit-t3kit-starter/feed)WikiDiscussions master Synced 2mo ago READMEChangelog (10)Dependencies (39)Versions (16)Used By (0) [ ![t3kit logo](https://user-images.githubusercontent.com/5150636/82044420-ff053600-96b5-11ea-8313-4158d6c0be5d.png) ](http://t3kit.com/) t3kit-starter ------------- [](#t3kit-starter) ### Starter point for a new project based on t3kit [](#starter-point-for-a-new-project-based-on-t3kit) [**t3kit documentation**](https://t3kit.gitbook.io/doc/) [![Code Guidelines](https://github.com/t3kit/t3kit-starter/actions/workflows/code-guidelines.yml/badge.svg)](https://github.com/t3kit/t3kit-starter/actions/workflows/code-guidelines.yml)[![Local development environment](https://github.com/t3kit/t3kit-starter/actions/workflows/local-dev-evironment.yml/badge.svg)](https://github.com/t3kit/t3kit-starter/actions/workflows/local-dev-evironment.yml) Table of contents ----------------- [](#table-of-contents) ### t3kit-starter [](#t3kit-starter-1) - [About](#about) - [What's included](#whats-included) - [Required dependencies](#required-dependencies) - [File structure](#file-structure) - [Quick start a new project on t3kit base](#quick-start-a-new-project-on-t3kit-base) - [Start with t3kit local development](#start-with-t3kit-local-development) - [Create your custom theme based on t3kit to extend the functionality](#create-your-custom-theme-based-on-t3kit-to-extend-the-functionality) - [Local development tools](#local-development-tools) - [Changelog](CHANGELOG.md) ### General info about t3kit project [](#general-info-about-t3kit-project) - [Documentation](https://t3kit.gitbook.io/doc) - [t3kit Roadmap](https://t3kit.gitbook.io/doc/t3kit-roadmap) - [Versioning](https://t3kit.gitbook.io/doc/t3kit-versioning) - [t3kit project structure](https://t3kit.gitbook.io/doc/t3kit-project-structure) - [Contributing to t3kit](https://github.com/t3kit/.github/blob/master/CONTRIBUTING.md) - [Code of Conduct](https://github.com/t3kit/.github/blob/master/CODE_OF_CONDUCT.md) - [Support](https://github.com/t3kit/.github/blob/master/SUPPORT.md) - [Security Policy](https://github.com/t3kit/.github/blob/master/SECURITY.md) --- About ----- [](#about) **t3kit-starter** is a bunch of tools, configs, and best practices which should help you to kickstart new projects on a t3kit basis What's included --------------- [](#whats-included) - Project folder structure - Composer configuration - t3kit and TYPO3 project dependencies - TYPO3 global configurations - TYPO3 context configurations - Custom site configurations - Local development environment based on Docker - Starter database - Tests - Code guidelines Required dependencies --------------------- [](#required-dependencies) - [Git](https://git-scm.com/) - [Composer](https://getcomposer.org/) >= v2.1.8 - [Docker](https://docs.docker.com/install/) >= v20.10.8 - [Docker Compose](https://docs.docker.com/compose/cli-command/#installing-compose-v2) >= v2.0.0 - [Node.js](https://nodejs.org/en/download/) >= v16.12.0 - [NPM](https://nodejs.org/en/download/) >= v8.0.0 - [nproxy](https://github.com/t3kit/t3kit-dockerhub#nproxy) >= v3.0.0 File structure -------------- [](#file-structure) ``` t3kit-starter/ ├── .github/ # github actions ├── .localconf/ │ ├── community/ # community configuration for t3kit, not supported by t3kit team │ ├── db/ # t3kit database manipulation - Setup/Restore/Pack │ └── docker/ # t3kit local development config based on Docker ├── config/ ├── extensions/ # Themes and other extensions belonging to this repository only └── public/ ├── typo3conf/ │ ├── AdditionalConfiguration.php │ ├── LocalConfiguration.php │ └── PackageStates.php └── fileadmin/ ``` ### Community configuration [](#community-configuration) We are open to any additional configuration on top of the t3kit. To add it just follow two rules below: 1. It always should be inside `.localconf/community/` folder 2. t3kit team will not support it ### Clean up the project [](#clean-up-the-project) If there no needs to use **t3kit** starter database or **Docker configuration** for local development, then just delete folder `.localconf` from the root of your project `rm -r .localconf` --- Quick start a new project on t3kit base (two options) ----------------------------------------------------- [](#quick-start-a-new-project-on-t3kit-base-two-options) 1. Start with `composer create-project` ``` composer create-project --no-dev --no-scripts --remove-vcs t3kit/t3kit-starter my-new-project v11.0.0-beta.2 ``` 2. Or use as a template in *GitHub* (recommended). If you are using *GitHub* to store your future project, then you can just clone *t3kit-starter* as a template to your new project repository with `Use this template` green button in *t3kit* organization in the *t3kit-starter* repository. Start with t3kit local development ---------------------------------- [](#start-with-t3kit-local-development) 1. Check that [nginx-proxy](#nginx-proxy) started 2. `git clone git@github.com:t3kit/t3kit-starter.git` - Clone the repository 3. `composer env` - Configure local development environment variables *\*Note: To continue with Docker based local development you need to create an environment `.env` file for your project based on an example `local.env`. You can create `.env` file by running: `composer env` as described above or `cp .localconf/local.env .env`.* - Check all environment variables in `.env` file and change them if it needed - OS-specific settings in `.env` file - **Linux** - Uncomment `USER_ID` var and set up your host user id to make the shared folder writable. (Skip this step if you are a Mac user) 4. `composer i` - Install composer dependencies, or run `composer ci` if you don't have PHP v8 as your main local environment 5. `npm install` - Install npm dependencies 6. `npm run dev` - Build development assests for themes 7. `docker compose up -d` - Start all Docker services for a local development environment 8. Setup t3kit starter database `composer dbup` 9. Open `t3kit11.t3.localhost` in browser *Google Chrome* 10. Open TYPO3 BE `t3kit11.t3.localhost/typo3` ---> *\[user: `admin`, password: `admin1234`\]* 11. Open TYPO3 Install tool `t3kit11.t3.localhost/typo3/install.php` ---> *\[password: `admin1234`\]* --- Create your custom theme based on t3kit to extend the functionality. -------------------------------------------------------------------- [](#create-your-custom-theme-based-on-t3kit-to-extend-the-functionality) `extensions/theme_newcustomproject` in this folder you can find an example of TYPO3 extension that can be a good starting point for extending the default t3kit theme. With this "subtheme" extension, you can change the design and add the necessary content elements while maintaining the main features of t3kit, and the ability to easily upgrade to newer versions of TYPO3 and t3kit. ### Quick start [](#quick-start) 1. Define a `name` for your new theme. For example, let's take the name `mega` 2. Create a new extension based on `theme_newcustomproject` ``` cp -r extensions/theme_newcustomproject extensions/theme_mega ``` *Note: Change the `mega` part in `extensions/theme_mega` to your real project neme* 3. Rename `newcustomproject` to your project name. In our example, we are using `mega` as a project name. - **Mac** ``` grep -rl 'newcustomproject' extensions/theme_mega | xargs sed -i '' 's/newcustomproject/mega/g' ``` - **Linux** ``` grep -rl 'newcustomproject' extensions/theme_mega | xargs sed -i 's/newcustomproject/mega/g' ``` *Note: Change the `mega` part in `**/extensions/theme_mega` and `s/newcustomproject/mega/g` to your real project neme* 4. Activate `theme_mega` extension - Install a new `theme_mega` extension ``` composer co require typo3-local/theme-mega:dev-master npm install npm run dev ``` 5. Enable `theme_mega` for the site `Site Management -> Sites -> Site Theme` --- Local development tools ----------------------- [](#local-development-tools) ### t3kit database manipulation - Setup/Restore/Pack [](#t3kit-database-manipulation---setuprestorepack) - Setup t3kit db: `composer dbup` - Restore t3kit db: `composer dbre` - Pack (save) t3kit db: `composer dbp` ### phpMyAdmin [](#phpmyadmin) #### Run phpMyAdmin docker container and connect it to needed DB host [](#run-phpmyadmin-docker-container-and-connect-it-to-needed-db-host) ``` docker run --name pma -d -e PMA_ARBITRARY=1 --restart=unless-stopped --network nproxy -p 8083:80 phpmyadmin/phpmyadmin ``` ### nginx-proxy [](#nginx-proxy) #### [nginx-proxy for t3kit11 project](https://github.com/t3kit/t3kit-dockerhub#nproxy) [](#nginx-proxy-for-t3kit11-project) For all t3kit projects, we need just a one `nginx-proxy` started as a separate Docker container. [Based on Automated Nginx Reverse Proxy for Docker](https://github.com/nginx-proxy/nginx-proxy) ##### Setup [](#setup) ``` git clone git@github.com:t3kit/t3kit-dockerhub.git cd t3kit-dockerhub/nproxy docker compose up -d ``` Community-contributed platforms ------------------------------- [](#community-contributed-platforms) These platforms are not officially supported by the t3kit team. - [Use t3kit with DDEV](.localconf/community/ddev/README.md) ### Health Score 27 — LowBetter than 49% of packages Maintenance0 Infrequent updates — may be unmaintained Popularity18 Limited adoption so far Community19 Small or concentrated contributor base Maturity62 Established project with proven stability Bus Factor1 Top contributor holds 91.8% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~104 days Recently: every ~141 days Total 11 Last Release 1048d ago Major Versions 10.1.0 → 11.0.0-beta2021-11-08 ### Community Maintainers ![](https://www.gravatar.com/avatar/59166c2c02937e84ce1913fb4ca9c3e7fe6f59d2b5ebb2064d6ee516fcf38d29?d=identicon)[t3kit](/maintainers/t3kit) --- Top Contributors [![dmh](https://avatars.githubusercontent.com/u/5150636?v=4)](https://github.com/dmh "dmh (490 commits)")[![mabolek](https://avatars.githubusercontent.com/u/8200271?v=4)](https://github.com/mabolek "mabolek (25 commits)")[![MattiasNilsson](https://avatars.githubusercontent.com/u/1718315?v=4)](https://github.com/MattiasNilsson "MattiasNilsson (9 commits)")[![pixelmatseriks](https://avatars.githubusercontent.com/u/5682324?v=4)](https://github.com/pixelmatseriks "pixelmatseriks (3 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (3 commits)")[![tonypro](https://avatars.githubusercontent.com/u/2727984?v=4)](https://github.com/tonypro "tonypro (1 commits)")[![ihorko-git](https://avatars.githubusercontent.com/u/836998?v=4)](https://github.com/ihorko-git "ihorko-git (1 commits)")[![mesosa](https://avatars.githubusercontent.com/u/4276194?v=4)](https://github.com/mesosa "mesosa (1 commits)")[![AntonAksonovResultify](https://avatars.githubusercontent.com/u/99887924?v=4)](https://github.com/AntonAksonovResultify "AntonAksonovResultify (1 commits)") --- Tags composerdockernginx-proxystarter-databaset3kitt3kit10typo3cmstypo3startert3kitt3kit10t3kit11 ### Code Quality Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/t3kit-t3kit-starter/health.svg) ``` [![Health](https://phpackages.com/badges/t3kit-t3kit-starter/health.svg)](https://phpackages.com/packages/t3kit-t3kit-starter) ``` ### Alternatives [t3kit/t3kit t3kit project. A TYPO3 website starterkit. 5624.3k](/packages/t3kit-t3kit)[typo3/cms-base-distribution TYPO3 CMS Base Distribution 21570.2k47](/packages/typo3-cms-base-distribution)[t3kit/theme-t3kit Base Theme fot t3kit project 2410.2k](/packages/t3kit-theme-t3kit)[pagemachine/typo3-formlog Form log for TYPO3 23225.3k6](/packages/pagemachine-typo3-formlog)[eliashaeussler/typo3-form-consent Extension for TYPO3 CMS that adds double opt-in functionality to EXT:form 1481.0k](/packages/eliashaeussler-typo3-form-consent) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)