README

t3kit-starter

基于t3kit的新项目起点

t3kit文档

目录

t3kit-starter

• 关于
• 包含内容
• 所需依赖项
• 文件结构
• 在t3kit基础上快速启动新项目
• 从t3kit本地开发开始
• 基于t3kit创建自定义主题以扩展功能
• 本地开发工具
• 变更日志

t3kit项目的一般信息

• 文档
• t3kit路线图
• 版本控制
• t3kit项目结构
• 为t3kit做贡献
• 行为准则
• 支持
• 安全策略

关于

t3kit-starter 是一系列工具、配置和最佳实践，可以帮助您在t3kit基础上快速启动新项目

包含内容

• 项目文件夹结构
• Composer配置
• t3kit和TYPO3项目依赖项
• TYPO3全局配置
• TYPO3上下文配置
• 自定义网站配置
• 基于Docker的本地开发环境
• 起点数据库
• 测试
• 代码规范

所需依赖项

• Git
• Composer >= v2.1.8
• Docker >= v20.10.8
• Docker Compose >= v2.0.0
• Node.js >= v16.12.0
• NPM >= v8.0.0
• nproxy >= v3.0.0

文件结构

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/

社区配置

我们欢迎在t3kit之上添加任何额外的配置。只需遵循以下两条规则即可添加它

1. 它始终应位于 .localconf/community/ 文件夹内
2. t3kit团队不会支持它

清理项目

如果不需要使用 t3kit 起点数据库或 Docker 本地开发配置，则只需从项目根目录中删除 .localconf 文件夹 rm -r .localconf

在t3kit基础上快速启动新项目（两种选项）

1. 使用 composer create-project 开始

   composer create-project --no-dev --no-scripts --remove-vcs t3kit/t3kit-starter my-new-project v11.0.0-beta.2

2. 或在 GitHub 中将其用作模板（推荐）。如果您使用 GitHub 存储未来的项目，则可以克隆 t3kit-starter 作为模板到您的新项目仓库。在 t3kit-starter 仓库中的 t3kit 组织中，通过 Use this template 绿色按钮即可。

从t3kit本地开发开始

1. 检查 nginx-proxy 是否已启动

2. git clone git@github.com:t3kit/t3kit-starter.git - 克隆仓库

3. composer env - 配置本地开发环境变量

   *注意：要继续基于Docker的本地开发，您需要根据示例 local.env 创建一个用于项目的环境 .env 文件。您可以通过运行上述描述中的 composer env 或 cp .localconf/local.env .env 来创建 .env 文件。

   • 检查 .env 文件中的所有环境变量，并在需要时进行更改
   • .env 文件中的操作系统特定设置
     • Linux
       • 取消注释 USER_ID 变量，并将主机用户 ID 设置为可写共享文件夹。如果使用的是 Mac，则跳过此步骤。

4. composer i - 安装 composer 依赖，如果没有 PHP v8 作为主本地环境，则运行 composer ci

5. npm install - 安装 npm 依赖

6. npm run dev - 为主题构建开发资源

7. docker compose up -d - 为本地开发环境启动所有 Docker 服务

8. 设置 t3kit 初始数据库 composer dbup

9. 在浏览器中打开 t3kit11.t3.localhost （谷歌浏览器）

10. 打开 TYPO3 BE t3kit11.t3.localhost/typo3 ---> （用户：admin，密码：admin1234）

11. 打开 TYPO3 安装工具 t3kit11.t3.localhost/typo3/install.php ---> （密码：admin1234）

基于 t3kit 创建自定义主题以扩展功能。

在 extensions/theme_newcustomproject 目录中，您可以找到一个 TYPO3 扩展的示例，该扩展可以作为扩展默认 t3kit 主题的良好起点。使用此“子主题”扩展，您可以在保持 t3kit 的主要功能的同时更改设计并添加必要的内容元素，并且能够轻松升级到 TYPO3 和 t3kit 的新版本。

快速入门

1. 为新主题定义一个 名称。例如，让我们取名为 mega

2. 基于 theme_newcustomproject 创建一个新的扩展

   cp -r extensions/theme_newcustomproject extensions/theme_mega

   注意：将 extensions/theme_mega 中的 mega 部分更改为您的真实项目名称。

3. 将 newcustomproject 重命名为项目名称。在我们的示例中，我们使用 mega 作为项目名称。

   • 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'

注意：将 extensions/theme_mega 和 **/extensions/theme_mega 以及 s/newcustomproject/mega/g 中的 mega 部分更改为您的真实项目名称。

1. 激活 theme_mega 扩展

   • 安装新的 theme_mega 扩展

       composer co require typo3-local/theme-mega:dev-master
       npm install
       npm run dev

2. 在 站点管理 -> 站点 -> 站点主题 中启用 theme_mega

本地开发工具

t3kit 数据库操作 - 设置/恢复/打包

• 设置 t3kit 数据库：composer dbup
• 恢复 t3kit 数据库：composer dbre
• 打包（保存）t3kit 数据库：composer dbp

phpMyAdmin

运行 phpMyAdmin Docker 容器并将其连接到所需的数据库主机

docker run --name pma -d -e PMA_ARBITRARY=1 --restart=unless-stopped --network nproxy -p 8083:80 phpmyadmin/phpmyadmin

nginx-proxy

t3kit11 项目的 nginx-proxy

对于所有 t3kit 项目，我们只需要一个单独启动的 nginx-proxy Docker 容器。基于 Docker 自动 Nginx 反向代理

设置

git clone git@github.com:t3kit/t3kit-dockerhub.git
cd t3kit-dockerhub/nproxy
docker compose up -d

社区贡献的平台

这些平台不是由 t3kit 团队官方支持的。

• 使用 t3kit 与 DDEV