edhaase / slim-skeleton
使用 Slim 构建网页服务或应用的脚手架
2.0.0
2016-01-08 17:26 UTC
Requires
- php: >=5.5.0
- monolog/monolog: ^1.17
- oscarotero/psr7-middlewares: ^3.8
- slim/slim: ~3.1
- tedivm/stash: ^0.13.1
Requires (Dev)
- codeception/codeception: ^2.1
- squizlabs/php_codesniffer: ^2.5
This package is not auto-updated.
Last update: 2024-09-24 19:06:42 UTC
README
目的
本仓库的目的是提供一个坚实的基础来构建使用 Slim 3 (Slim 3 (repo) 的现代实践) 的网页服务,并提供一些示例来展示如何使用其功能。为此,提供了一些示例路由和控制器,以及由 Stash 提供的基本日志器和 APC/APCu 缓存。测试由 Codeception 提供。
安装
通过 composer
composer create-project edhaase/slim-skeleton [目标目录]
.
通过 git
- 克隆此仓库
- 运行
composer install
- 运行
composer bootstrap
或composer run-script post-create-project-cmd
- 享受吧!
关于自动加载器
本项目使用 PSR-4 自动加载。请参阅 composer.json
中的映射。如果更改它们,您将需要重新构建自动加载器。您可以通过运行 composer dump-autoload --optimize
来完成此操作。
结构
docs/ - PHPDoc output
logs/ - Log output
public/ - Site configuration entry point limits what we expose
tests/ - Codeception tests
src/
Controller/ - Route controllers
Model/ - Data models
Service/ - Service providers
app.php - Primary application
routes.php - Route creation
vendor/ - Composer install directory
config.example.php - Example application config constants
文档
可以使用 phpDocumentor 生成文档。
测试
composer test
代码规范
本项目遵循 PSR-2 编码风格。
脚本
我们还通过 composer 提供了一些脚本,以简化操作。
composer
codecept - shortcut to codecept
test - alias for codecept run
cs - alias for "phpcs --standard=PSR2 src/",
cbf - alias for "phpcbf --standard=PSR2 src/",
serve - starts test server
bootstrap - alias to @post-create-project-cmd