oanhnn / slim-skeleton
Slim 框架的骨架
v3.1.0
2016-07-29 03:10 UTC
Requires
- php: >=5.5.0
- doctrine/dbal: ^2.5
- monolog/monolog: ~1.13
- slim/http-cache: ^0.3.0
- slim/php-view: ^2.0
- slim/slim: ~3.0
Requires (Dev)
Suggests
- cakephp/database: Required to use CakePHP Database service provider (^3.1).
- doctrine/dbal: Required to use Doctrine DBAL service provider (^2.5).
- monolog/monolog: Required to use log service provider (~1.13)
- slim/csrf: Required to protect CSRF attack by csrf middleware (^0.4.0).
- slim/flash: Required to use flash message service provider (^0.1.0)
- slim/http-cache: Required to use http cache service provider (^0.3.0).
- slim/php-view: Required to use PHP view service provider (^2.0).
- slim/twig-view: Required to use Twig view service provider (^2.0).
This package is auto-updated.
Last update: 2024-08-25 06:13:14 UTC
README
遵循 MVC 模式为 Slim Framework v3 创建的骨架。
主要特性
- 支持使用 PSR-3 和 Monolog 的日志记录
- 支持模板引擎:PHP 视图,Twig(默认 PHP 视图)
- 支持使用 Doctrine DBAL,CakePHP Database(支持 MySql,Postgresql,SQLite 等)进行数据库访问
- 支持中间件:基本 & 摘要认证
- 支持提供者,易于与
slim/http-cache
,slim/csrf
,slim/flash
集成 - 支持使用 PHPUnit 进行数据库测试和集成测试
- 支持使用 PHPCS 进行代码风格检查
- 支持使用 Deployer 进行自动化部署
- 支持使用 Gulp 任务编译 SASS,ES6,CoffeeScript 等
目录结构
path/to/project
|-- app
| |-- assets
| |-- config
| |-- lang
| `-- templates
|-- public
|-- src
|-- tests
|-- tmp
| |-- cache
| `-- logs
`-- vendor
要求
- PHP 5.5+
- [Composer][compoer]
- npm(如果使用 Gulp 构建资源)
用法
创建项目
使用 composer
创建新项目
$ composer create-project oanhnn/slim-skeleton path/to/project --prefer-dist
运行 PHP 内置服务器
在 0.0.0.0:8888 上运行内置服务器
$ php -S 0.0.0.0:8888 -t public public/index.php
使用地址 http://localhost:8888 打开网络浏览器
检查代码风格和测试
$ ./vendor/bin/phpcs $ ./vendor/bin/phpunit
使用 gulp,npm 构建资源
您可以使用 Gulp 编译 SASS,ES6,CoffeeScript 等
$ npm install $ npm run-script build
使用 gulp 运行任务
$ node_modules/.bin/gulp <task>
部署项目
您可以使用 Deployer 部署项目。
从 deploy.php.dist
文件复制并编辑服务器的信息到 deploy.php
文件。
之后,您可以运行
$ composer require deployer/deployer:^3.3.0 --dev $ ./vendor/bin/dep <stage>
在 这里 查看示例。
变更日志
在 CHANGELOG.md 中查看所有变更日志
贡献
所有代码贡献必须通过拉取请求,并由核心开发者批准后才能合并。这是为了确保对所有代码的适当审查。
Fork 项目,创建一个功能分支,并提交拉取请求。
为了确保代码库的一致性,您应该确保代码遵循 PSR-2。
如果您想帮忙,请查看 问题列表。
许可
该项目根据 MIT 许可证发布。
版权所有 © 2013-2016 Oanh Nguyen。
有关更多信息,请参阅 许可文件。