hidalgo-rides/intersect-framework

专为让开发生活更轻松而构建的Web框架。

1.3.0 2020-04-16 04:16 UTC

README

一个用于让开发生活更轻松的PHP Web框架。

使用Composer安装

运行以下命令使用Composer创建项目

composer create-project hidalgo-rides/intersect-framework <directory-path>

使用Docker本地部署

现在你应该准备好启动Docker环境(必须已安装Docker)

# navigate to directory where you installed your project files
cd <directory-path>

# bring up the project using docker-compose
docker-compose up -d

环境启动后,你可以在浏览器中访问https://:8080

有用的端点/端口

(端口在docker-compose.yml文件中定义)

有用的Docker命令

启动本地环境

运行以下Docker命令以在Docker容器内加载环境

docker-compose up -d

停止本地环境

运行以下Docker命令以拆除环境并停止Docker容器

docker-compose down

查看本地日志

如果您想查看Docker环境的日志,请运行以下Docker命令

docker-compose logs -f

数据库迁移

Intersect使用了内置的数据库迁移支持。迁移文件是一种定义数据库表定义、开发时的种子数据,以及通过源代码控制维护数据库模式的有效方法。

以下是一些您可以使用来创建迁移文件、创建种子文件、应用现有迁移和重置数据库的命令。

创建迁移文件

docker exec app sh -c 'php intersect migrations:generate CreateXXXTable'

(您可以将最后一个参数"CreateXXXFile"替换为您想要的任何内容)

您的新迁移文件将创建在src/Migrations目录下。

创建种子数据文件

种子数据文件用于在开发或测试期间创建可以使用的数据。这些种子数据文件在应用其他迁移时不会自动应用。种子数据文件总是在所有其他迁移文件运行完毕后最后应用。(如果使用了--seed标志)

docker exec app sh -c 'php intersect migrations:generate-seed SeedDataFile'

应用迁移文件(无种子数据)

docker exec app sh -c 'php intersect migrations:run'

应用迁移文件(有种子数据)

docker exec app sh -c 'php intersect migrations:run --seed'

重置数据库(无种子数据)

docker exec app sh -c 'php intersect migrations:reset'

重置数据库(有种子数据)

docker exec app sh -c 'php intersect migrations:reset --seed'

运行PHPUnit测试

确保Docker容器已启动,如果不是,请参阅启动和停止环境部分

运行

运行以下命令运行PHPUnit测试("app"与docker-compose.yml中定义的服务相匹配)

docker exec app vendor/bin/phpunit

运行带有覆盖率报告

如果您想在运行PHPUnit测试的同时生成代码覆盖率报告,请运行以下命令("app"与docker-compose.yml中定义的服务相匹配)

docker exec app vendor/bin/phpunit --coverage-html=./tests/coverage-results

这将在tests/coverage-results目录下创建您的覆盖率报告

许可证

Intersect框架是开源软件,根据MIT许可证许可。