scaffold icon indicating copy to clipboard operation
scaffold copied to clipboard

scaffold是一个基于Yii2高级项目模版工程化实现的应用程序

Yii 2 Scaffold Project Kit


易加-脚手架(scaffold)是一个基于Yii2高级项目模版工程化实现的应用程序,它将更加高效、规范和工程化的满足项目开发的需求。

Latest Stable Version Total Downloads Build Status DOCS Yii2 Apache--2.0

DIRECTORY STRUCTURE

common
    config/              contains shared configurations
    mail/                contains view files for e-mails
    models/              contains model classes used in both backend and frontend
    tests/               contains tests for common classes    
console
    config/              contains console configurations
    controllers/         contains console controllers (commands)
    migrations/          contains database migrations
    models/              contains console-specific model classes
    runtime/             contains files generated during runtime
backend
    assets/              contains application assets such as JavaScript and CSS
    config/              contains backend configurations
    controllers/         contains Web controller classes
    models/              contains backend-specific model classes
    runtime/             contains files generated during runtime
    tests/               contains tests for backend application    
    views/               contains view files for the Web application
    web/                 contains the entry script and Web resources
frontend
    assets/              contains application assets such as JavaScript and CSS
    config/              contains frontend configurations
    controllers/         contains Web controller classes
    models/              contains frontend-specific model classes
    runtime/             contains files generated during runtime
    tests/               contains tests for frontend application
    views/               contains view files for the Web application
    web/                 contains the entry script and Web resources
    widgets/             contains frontend widgets
api
    config/              contains api configurations
    controllers/         contains Web controller classes
    models/              contains api-specific model classes
    runtime/             contains files generated during runtime
    tests/               contains tests for api application
    web/                 contains the entry script and Web resources
vendor/                  contains dependent 3rd-party packages
docker/                  contains docker for project
vagrant/                 contains vagrant for project
environments/            contains environment-based overrides

快速安装

  • 安装 Composer 依赖管理

  • 安装 Docker 应用容器引擎

  • 基于容器化环境部署

    # 克隆代码
    git clone https://github.com/yiiplus/scaffold.git
    
    # 进入项目目录
    cd scaffold
    
    # 设置Git配置
    git config user.name "yourname"
    git config user.email "your email" 
    
    # 编译环境
    # 如果安装失败请尝试添加 GitHub 密钥:
    # 进入 https://github.com/settings/tokens 点击 「Generate new token」 新建一个 Token;
    # 编辑 vim composer.json
    #    "config": {
    #        "github-oauth": {
    #            "github.com": "<token>"
    #        }
    #    }
    composer run-script docker:build
    
    # 代码规范检查
    ./vendor/bin/phpcs --standard=PSR2 --ignore=tests,docs/,docker/,vendor/,console/migrations,backend/runtime,frontend/runtime,api/runtime,console/runtime,frontend/web/assets,backend/web/assets,api/web/assets -n --colors ./
    # 质量检查工具
    ./vendor/bin/phpmd environments,common,console,backend,frontend,api text phpmd.xml --exclude tests,docs/,docker/,vendor/,console/migrations,backend/runtime,frontend/runtime,api/runtime,console/runtime,frontend/web/assets,backend/web/assets,api/web/assets
    
  • 访问地址

    • Admin: http://admin.scaffold.local 用户名:webmaster 密码:111111
    • PC: http://www.scaffold.local
    • H5: http://h5.scaffold.local
    • App: http://app.scaffold.local
    • FIS3: http://fis3.scaffold.local
    • phpMyAdmin: http://pma.scaffold.local 服务器:mysql 用户名:root 密码:root

文档中心

  • 入门学习
  • Docker手册
  • 团队编码规范
  • 接口文档
    • App接口文档
    • 开放数据接口(openapi)
    • 内部数据接口(innerapi)
  • 数据字典
    • 数据库手册
    • 缓存手册
    • 邮件和短信
  • 服务文档
    • 日志服务
    • 队列服务
    • 定时任务
    • 监控报警
  • 异常解决
    • 错误对照表
    • 调试及调试工具
  • 技术白皮书
  • FAQ