README

Arcturus项目

由Oneago开发的PHP框架

在packagist.org上查看此项目

系统要求

• PHP 7.4或更高版本
• Composer
• docker-compose（可选，用于在Docker服务器上运行）
• npm（可选，用于TypeScript和Sass编译）
• git（可选，用于版本控制）

入门指南

Composer安装程序

composer create-project oneago/arcturus-project <project-name>

Arcturus CLI安装程序

• 在此处查看安装指南

• 安装Arcturus CLI安装程序后，在命令行中运行安装项目内的arcturus <project name>

库

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

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）：如果设置了此选项，则在组件目录中创建组件，否则在css目录中创建
  • --dir（-d）：将在目录中创建sass文件，不使用--component或-c选项，因为没有创建文件夹
  • --parent（-p）：要添加组件导入的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