entanet / entanet-insights
一个向 entaqa 应用发送数据以可视化项目问题的包。
dev-master
2019-08-30 09:29 UTC
Requires
- php: ^7.1.3
- nunomaduro/collision: ^2.0
- nunomaduro/phpinsights: ^1.7
- superbalist/laravel-pubsub: ^3.0.0
- superbalist/php-pubsub: ^2.0.0
This package is auto-updated.
Last update: 2024-09-29 06:31:04 UTC
README
这是一个设计用于分析您的项目代码并提供如何通过可视数据和代码改进的痕迹来改进项目的包。这包括:代码、复杂性、架构和样式。
该包的目的是安装到您的应用中,运行 artisan 命令后,将提取并格式化数据,然后将数据发送到“entaqa”应用,以便可视化并更新。
安装
需要 Entanet Insights 包
composer require entanet/entanet-insights --dev
将以下内容添加到 config/app.php 的 providers 数组中
Superbalist\LaravelPubSub\PubSubServiceProvider::class
发布 insights 命令
php artisan vendor:publish --provider="NunoMaduro\PhpInsights\Application\Adapters\Laravel\InsightsServiceProvider"
php artisan vendor:publish --provider="Entanet\Insights\InsightsServiceProvider"
确保命令可用
app/console/commands/EntanetInsights.php
现在在以下位置注册该命令
app/console/commands/Kernel.php
注册为(在顶部)
use Entanet\Insights\EntanetInsights;
然后将此内容添加到 $commands 数组中
/**
* The Artisan commands provided by your application.
*
* @var array
*/
protected $commands = [
EntanetInsights::class
];
确保您的环境包含有效的 Kafka 凭据,并且 Kafka 已在您的机器上或您使用的容器内设置。
KAFKA_BROKERS=kafka.broker.com
PUBSUB_CONNECTION=kafka
KAFKA_CONSUMER=ryan
用法
目录
运行
Entaqa 应用
从 --repo-- 拉下 entaqa 应用。在项目路由中运行
docker-compose up --build -d
并导航到
localhost:8080
此应用使用 Google 认证进行登录。
监听
要监听 EntaQA 应用中的分数,请运行
docker-compose exec entaqa-app php artisan scores:listen
发送分数
请确保您已在 config/app.php 文件中设置 "app name",并在您的环境变量中设置 APP_NAME。
设置后运行
php artisan config:clear
这负责在 entaqa 中命名项目。遵循存储库命名约定,其中包含连字符、下划线、驼峰和蛇形都是可以的。
在您已安装 entanet-insights 的项目内部运行
php artisan entanet:insights
您应该看到 "Data Sent!" 作为确认。
现在,如果您刷新 entaqa 应用,您的应用将显示如何改进的可视数据,并且如果您点击代码、复杂性、架构或样式的部件,您可以深入了解如何从该特定角度改进您的应用。
享受吧!