Yii2 Starter Kit 项目安装与配置指南

前言

Yii2 Starter Kit 是一个基于 Yii2 框架的高级应用模板，它提供了丰富的开箱即用功能，包括用户管理、RBAC权限控制、多语言支持等。本文将详细介绍如何安装和配置这个强大的开发起点项目。

环境准备

在开始安装之前，请确保您的系统满足以下要求：

1. PHP环境：PHP 7.0 或更高版本
2. 必备扩展：
   • intl（国际化支持）
   • gd（图像处理）
   • com_dotnet（仅Windows系统需要）
3. 工具链：
   • Composer（PHP依赖管理）
   • Node.js 和 npm（前端资源构建）
   • Taskctl（可选，任务运行工具）

获取项目代码

方式一：通过Composer创建项目（推荐）

这是最简便的安装方式，执行以下命令：

composer create-project yii2-starter-kit/yii2-starter-kit myproject.com

此命令会自动下载最新稳定版本并安装基础依赖。

方式二：手动下载源码

如果您偏好手动安装，可以下载源码压缩包或使用Git克隆仓库：

git clone 仓库地址

依赖安装

项目依赖包括PHP包和前端资源两部分：

# 使用taskctl工具（推荐）
taskctl install

# 或手动安装
composer install
npm install

Docker安装方式（推荐开发环境使用）

对于开发环境，使用Docker是最便捷的选择：

1. 确保已安装Docker和docker-compose
2. 执行构建命令：

   taskctl start
   # 或
   composer run-script docker:build
   

3. 访问 http://yii2-starter-kit.localhost 即可使用

Docker环境实用技巧

• 进入容器执行命令：

  docker-compose exec app bash
  

• 执行Yii控制台命令：

  docker-compose exec app console/yii migrate
  

手动安装配置

基础配置步骤

1. 生成环境配置文件：

   taskctl build:env
   

2. 编辑生成的.env文件，配置关键参数：

   • 调试模式和环境设置
   • 数据库连接信息
   • 各应用模块的访问URL

3. 执行初始化命令：

   taskctl local:build
   # 或
   php console/yii app/setup
   npm run build
   

Web服务器配置

项目支持Nginx和Apache，配置时需注意：

1. 参考提供的vhost.conf模板
2. 特别注意静态资源的路由规则
3. 如果使用Vagrant，需关闭sendfile功能以避免文件损坏

单域名部署方案

在某些场景下，您可能需要将所有模块部署在单一域名下：

1. 修改.env文件中的基础URL配置
2. 调整前后端的配置文件中的request组件设置
3. 配置Web服务器重写规则

演示数据与测试账户

项目提供了便捷的演示数据生成功能：

# 生成N条测试数据
console/yii app/demo-data N

内置测试账户：

• 管理员：webmaster/webmaster
• 经理：manager/manager
• 普通用户：user/user

注意事项

1. 生产环境务必关闭调试模式（YII_DEBUG=false）
2. 文件上传功能需要确保storage目录可写
3. 多语言切换依赖intl扩展
4. 定时任务需要正确配置cron

结语

Yii2 Starter Kit 提供了完善的开发起点，通过本文的安装指南，您应该已经成功搭建起了开发环境。接下来可以开始探索其丰富的功能模块，或基于此模板开发您自己的应用。如果在安装过程中遇到问题，建议查阅详细的错误日志，大多数问题都能从中找到解决方案。