oneago/oneago-php-template

此包已被 放弃 并不再维护。作者建议使用 oneago/arcturus-project 包。

Arcturus 项目是一个易于快速开发 PHP 项目的 Oneago 开源项目。

安装: 34

依赖: 0

建议: 0

安全: 0

星星: 0

观察者: 1

分支: 0

开放问题: 2

类型:项目

v4.0.7 2023-01-21 00:47 UTC

README

Imgur

GitHub repo size GitHub code size in bytes Packagist Downloads Packagist License Packagist Version Packagist PHP Version Support GitHub issues GitHub commit activity

Arcturus 项目

Oneago 开发的 PHP 框架

packagist.org 上查看此项目

系统要求

  • PHP 7.4 或最新版本
  • Composer
  • docker-compose(可选,用于 Docker 服务器运行)
  • npm(可选,用于 TypeScript 和 Sass 编译)
  • git(可选,用于版本控制)

入门

Composer 安装程序

composer create-project oneago/arcturus-project <项目名称>

Arcturus CLI 安装程序

  • 请参阅安装指南

  • 安装 Arcturus CLI 安装程序后,在安装项目内部运行命令行 arcturus <项目名称>

Arcturus 实现了 4 个库,需要先前的文档才能获得最佳效果

描述 文档
Twig 受 Django 模板启发的 PHP 模板引擎,具有 .twig 扩展和 XSS 攻击保护 twig 3.x 文档
Phinx DPhinx 使管理 PHP 应用程序的数据库迁移变得非常容易。Phinx 专注于迁移,没有数据库 ORM 系统或框架的冗余。 Phinx 0.12 文档
phpunit PHPUnit 是一个面向程序员的 PHP 测试框架。它是单元测试框架 xUnit 架构的一个实例。 PHPUnit 文档

Ada CLI 可用命令

在项目文件夹中运行 ./ada(Linux)或 php ada 以获取脚本帮助

docker

管理项目容器。需要在系统中安装 docker-compose 和 docker

  • docker:run

    运行 docker-compose.yml 文件并启动容器

      php ada docker:run
    
  • docker:pull

    从 Docker Hub 拉取 docker-compose.yml 容器

      php ada docker:run  
    
  • docker:kill

    终止 docker-compose.yml 容器

      php ada docker:kill
    

make

创建新项目文件

  • make:api

    为该应用程序创建新的 API

      php ada make:api [options] [--] <api name>
    
  • make:view

    通过传递名称创建一个新的视图

      php ada make:view [options] [--] <view name>
    

    参数

    • 视图名称:用于新视图文件和/或模型文件中的名称

    选项

    • --dir (-d):如果需要在新目录或现有目录中创建视图,请使用此选项并指定目录名称。将视图保存到文件夹以供美观查看器使用
    • --no-controller:仅在新视图目录中创建 twig 文件,不创建控制器
  • make:model

    为此应用程序创建一个新的模型

      php ada make:model <model name>  
    

    参数

    • 模型名称:用于新模型中的名称
  • make:middleware

    通过传递名称创建一个新的中间件

      php ada make:middleware <middleware name>
    

    参数

    • 中间件名称:用于新中间件中的名称

run

  • run:release

    制作包含生产项目文件的 zip 文件

      php ada run:release [<name>]
    

    参数

    • 名称:zip 文件的名称 [默认: "release"]
  • run:server

    启动一个 PHP 服务器

      php ada run:server <address> 
    

    参数

    • 地址:运行 PHP 主机的地址。例如:localhost:8090

sass

管理 sass 文件。要求系统已安装 sass

  • sass:compile

    编译 app/sass 中的所有 sass 文件

      php ada sass:compile
    
  • sass:new

    编译 app/sass 中的 sass 文件

      php ada sass:new [options] [--] <name>
    

    参数

    • 名称:新 sass 文件的名称。如果名称没有扩展名,则自动添加 .sass 扩展名

    选项

    • --component (-c):如果设置此选项,则在 components 目录中创建组件,否则在 css 目录中创建
    • --dir (-d):将在目录中创建 sass 文件,无需使用 --component 或 -c 选项,因为没有创建文件夹
    • --parent (-p):在 css 目录中添加组件导入的 sass 父级 [默认: "style.scss"]
  • sass:watch

    此命令自动编译 app/sass 中的 sass 文件

      php ada sass:watch <name>
    

    参数

    • 名称:sass 文件的名称

tsc

管理 TypeScript 文件。要求系统已安装 npm

  • tsc:compile

    编译 app/typescript 中的所有 ts 文件

      php ada tsc:compile