taeluf / provi
0.1.1
2020-08-10 09:52 UTC
Requires
- league/commonmark: 1.5.1
- taeluf/liaison: dev-version_1
Requires (Dev)
- taeluf/documentor: dev-version_1
- taeluf/unit-tester: dev-version_1
This package is auto-updated.
Last update: 2024-09-27 21:05:45 UTC
README
Provi Php (项目查看器)
使用文档查看器和源代码查看器展示您的软件,支持分支选择、Git Webhooks、主题(最终),还有更多。
查看Taeluf.com/docs/获取示例!
状态:开发中,文档不足,未完善
目前它在Taeluf.com/docs/中使用,但可能还没有准备好供大多数人使用
主要问题
- 没有内置的服务器集成支持,我唯一一个完整的工作示例是闭源的。有一个部分且不理想的示例在test/Server/deliver.php
- Gitlab Webhooks已实现!但是gitHUB Webhooks还没有。(也许它们工作方式相同?我不知道)
- 它处于alpha阶段,所以肯定会有些破坏性的变更
需求
passthru('echo "/path/to/git-pull" | at 10:27')
必须在您的web服务器上工作(时间总是下一个分钟,且git-pull在bin/git-pull)。
安装
composer require taeluf/provi v0.9.x-dev
或在您的composer.json
{"require":{ "taeluf/provi": "v0.9.x-dev"}}
如何使用
警告:目前还没有简单的方法来设置web服务器,它没有文档,这可能会让您头疼,其他事情也缺乏文档。
- 创建一个
projects
目录 - 在那个目录中创建一个
settings.json
文件并填写它。示例在test/Server/projects/settings.json cd /your/projects_dir;
然后运行/path/to/provi/code/get-all-repos.php
下载settings.json中定义的所有项目- 与您的服务器/路由代码集成(抱歉这还没有文档!)
- 设置Gitlab Webhooks(在gitlab.com上)。GitHub Webhooks尚未实现
- 推送到您的服务器!(也许首先在本地测试一下)
许可证
目前,它处于MIT许可证下,但将来我可能会切换到不同的许可证,该许可证允许免费使用最多5个项目,最多50个项目需要支付约5美元。