From 77c9208e88e2272b8f4db18bc8a1edf51f2dfd69 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B7=B4=E6=8B=89=E8=BF=AA=E7=BB=B4?= Date: Sat, 7 May 2022 11:07:20 +0800 Subject: [PATCH] =?UTF-8?q?=E8=B0=83=E6=95=B4=20README=20=E8=AF=B4?= =?UTF-8?q?=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .dockerignore | 3 ++- .gitignore | 3 ++- README.md | 38 +++++++++++++++++--------------------- 3 files changed, 21 insertions(+), 23 deletions(-) diff --git a/.dockerignore b/.dockerignore index b70c27a..d16723b 100644 --- a/.dockerignore +++ b/.dockerignore @@ -2,4 +2,5 @@ docker/container-data .vscode tmp -build \ No newline at end of file +build +.idea \ No newline at end of file diff --git a/.gitignore b/.gitignore index 7c0e75f..25f5df3 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,5 @@ docker/container-data !docker/container-data/.keep .vscode tmp -build \ No newline at end of file +build +.idea \ No newline at end of file diff --git a/README.md b/README.md index d8169cd..e9ae65d 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,16 @@ 开源代码仓库的 star、fork、commit、pull request、issue 等相关数据，是分析和了解代码仓库的客观依据，这些数据在一定程度上反应了开源项目的受欢迎程度、活跃度、影响力等。 RepoStats 致力于解决的痛点问题是： -1. 开源代码仓库的数据抓取、存储、分析及统计 (当前版本仅支持 Gitee 平台) +1. 开源代码仓库的数据抓取、存储、分析及统计 1. 开源代码仓库的相关数据可视化展示 -1. 做到全平台打通，并支持分隔、组合展示 +1. 做到全网、全平台平台打通，并支持分隔、组合展示 主要原理示意图如下： ![RepoStats 示意图](https://oscimg.oschina.net/oscnet/up-fc53571df1456fa0ab21db5831ca129d05a.jpg) ## 功能说明 -1. 当前版本的 RepoStats 仅支持 Gitee 平台相关数据获取 (后续会持续新增其他平台，国产平台优先考虑) +1. 支持平台：当前版本的 RepoStats 仅支持 Gitee 平台相关数据获取 1. 管理后台：支持界面化的 Gitee Oauth 配置、Grafana Token 获取配置 1. 管理后台：支持添加单个仓库、支持批量添加个人帐号及组织帐号下的公开仓库 1. 管理后台：支持禁用、启用 Gitee 数据抓取(启动抓取除外) @@ -45,15 +45,8 @@ make compress-linux ### 3. 使用各系统分发版本 -启动参数说明 - -```shell -repostats [-c config_file] -``` - 通过 Release 下载对应平台的分发版并启动运行，启动之前请确保 `repostats.ini` 配置文件中各项内容的正确性 - ```ini [repostats] debug = false @@ -76,13 +69,21 @@ user = admin password = admin ``` -**数据库说明：** +数据库说明 + 1. 请在 `PostgreSQL` 数据库中创建名称 `repostats` 的数据库 -1. 请分别 **顺序执行** `sql/db.sql`、`sql/gitee.sql`、`sql/roles.sql` 创建必要的表及视图等 +2. 请分别 **顺序执行** `sql/db.sql`、`sql/gitee.sql`、`sql/roles.sql` 创建必要的表及视图等 + +启动参数说明 + +```shell +repostats [-c config_file] +``` ## 使用前置条件 RepoStats 启动成功之后，请使用帐号密码登录 Admin 管理后台。管理后台默认的账户名密码信息如下： + ``` repostats -2aDzm=0(ln_9^1 @@ -173,20 +174,15 @@ Commit Auhtor 次数排行 - Commit Committer 排行 Commit Committer 次数排行 -## 数据抓取策略 +## 截图分享 -RepoStats 启动之后，默认情况下每隔 `6小时` 抓取一次数据并更新 Grafana 视图面板 - - -## Screenshots - -1. 所有仓库总视图 +所有仓库总视图 ![所有仓库总视图](https://oscimg.oschina.net/oscnet/up-1d0f56655abc5a92846614e9862620e55b4.jpg) -1. 指定某个仓库的视图 +指定某个仓库的视图 ![指定某个仓库的视图](https://oscimg.oschina.net/oscnet/up-6fac497c4428602cc7a44a363c7b674165a.jpg) -1. Admin 后端管理界面 +Admin 后端管理界面 ![Admin 后端管理界面](https://oscimg.oschina.net/oscnet/up-101d6ca0c57de648c7fa20ec7b3f863fcd6.jpg) ## Contributor License Agreement