selenesoftware / selenestaticskeleton
Requires
This package is auto-updated.
Last update: 2024-08-29 04:54:47 UTC
README
由 Twig 和 Markdown 构建的相对较小的静态网站构建器,不是以博客为中心的。
入门指南
以下说明将帮助您在本地机器上安装项目副本并运行,以便进行开发和测试。有关如何将项目部署到实际系统上的说明,请参阅部署部分。
先决条件
Composer npm/Yarn PHP 7.2+
安装
一系列逐步示例,说明如何配置开发环境
说明步骤将要做什么
composer create-project selenesoftware/seleneSite
运行测试
解释如何运行本系统的自动化测试。我没有测试。它如此小巧,测试似乎比实际代码更大。不希望这样。
代码样式
实际构建器和骨架的代码由 PHP CS Fixer(friendsofphp/php-cs-fixer)检查。存在一个 .php_cs.dist 文件,其中包含 Selene 软件通常运行的规则。您可以自由调整它以符合自己的样式指南。
php-cs-fixer fix
部署
运行 bin/app.php 后,'web' 目录中会创建文件。然后运行 npm run build,您就有可用于生产的文件了。将 'web' 目录中的所有内容放入您的生产环境中。
构建工具
- Twig - 使用的渲染引擎
- Composer - 依赖管理
- Symfony Encore - 资产打包
贡献
请阅读 CONTRIBUTING.md 以了解我们的行为准则和提交拉取请求的流程。
提交拉取请求时,请确保您提交的是具有下一个版本号的特性分支。如果您的拉取请求仅包含文档,请随时对 master 进行拉取。
提交时,请更新下面的作者部分。
版本控制
我们使用 SemVer 进行版本控制。有关可用版本,请参阅此存储库的 标签。我们还努力使骨架与库保持相同的版本。
升级
我们尽量在版本之间尽可能少地修改骨架,因为插件是在应用程序文件中构建的。但为了升级库,只需更新 composer 即可
composer update
作者
- Jason Marshall - 初始工作 - psion
许可
本项目采用 Apache 许可协议 - 详细信息请参阅 LICENSE-2.0.md 文件