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

方法二：手动下载源码

您也可以直接下载项目压缩包，解压后进入项目目录。

依赖安装

安装所有必要的依赖项：

taskctl install

或者分步执行：

composer install  # 安装PHP依赖
npm install      # 安装前端依赖

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

对于开发环境，使用Docker可以快速搭建一致的运行环境：

1. 安装Docker和docker-compose
2. 运行以下命令启动服务：

taskctl start

3. 应用将自动在 http://yii2-starter-kit.localhost 可用

Docker常见问题

如何执行Yii控制台命令？

docker-compose exec app console/yii migrate

如何连接数据库？

• 主机：yii2-starter-kit.localhost
• 端口：3306
• 用户名：root
• 密码：root

手动安装配置

环境配置

1. 生成环境配置文件：

taskctl build:env

2. 编辑生成的 .env 文件，配置以下关键项：

# 调试模式和环境设置
YII_DEBUG = true
YII_ENV = dev

# 数据库配置
DB_DSN = mysql:host=127.0.0.1;port=3306;dbname=yii2-starter-kit
DB_USERNAME = user
DB_PASSWORD = password

# 应用URL设置
FRONTEND_HOST_INFO = http://yii2-starter-kit.localhost
BACKEND_HOST_INFO = http://backend.yii2-starter-kit.localhost
STORAGE_HOST_INFP = http://storage.yii2-starter-kit.localhost

应用初始化

运行以下命令完成应用设置：

taskctl local:build

或者手动执行：

php console/yii app/setup  # 初始化应用
npm run build            # 构建前端资源

Web服务器配置

建议使用Nginx作为Web服务器，可以参考项目中的 docker/vhost.conf 配置文件进行设置。特别注意：

• 如果使用Vagrant环境，需禁用sendfile功能以避免文件损坏问题：

sendfile off;

单域名安装配置

如果您希望所有应用（前端、后端、存储）都运行在同一个域名下：

1. 修改 .env 文件：

FRONTEND_BASE_URL = /
BACKEND_BASE_URL = /backend/web
STORAGE_BASE_URL = /storage/web

2. 调整后端和前端的配置文件中的 baseUrl 设置

演示数据

添加测试文章数据

生成随机文章和分类数据：

console/yii app/demo-data 30  # 30为生成的数据量

Docker环境下：

docker-compose exec app console/yii app/demo-data

预置用户账号

系统提供了三个测试账号：

• 管理员：

  • 用户名：webmaster
  • 密码：webmaster

• 经理：

  • 用户名：manager
  • 密码：manager

• 普通用户：

  • 用户名：user
  • 密码：user

注意事项

1. 生产环境务必关闭调试模式：

   YII_DEBUG = false
   YII_ENV = prod
   

2. 数据库配置应根据实际环境调整，确保使用强密码

3. 首次安装后，建议立即修改默认用户密码

4. 文件存储配置应根据实际需求调整，可能需要配置额外的存储服务

通过以上步骤，您应该已经成功安装并配置了Yii2 Starter Kit项目。这个强大的开发起点将帮助您快速构建功能完善的Web应用。