logo
0
0
WeChat Login
ForkfromCommit/Backend, aheadmain14 commits, behindmain163 commits

CNB Readme Stats · EdgeOne Edition

EdgeOne Pages License

为 CNB (cnb.cool) 仓库生成精美的徽章和图表,基于 EdgeOne Pages Node Functions 的 Serverless 实现。完美适配微信、Markdown 等场景。

🚀 快速开始

一键部署

您可以通过 腾讯云 EdgeOne Pages 一键部署。

直接点击此按钮一键部署:

使用 EdgeOne Pages 部署

查看 腾讯云 EdgeOne Pages 文档 了解更多详情。

注意:设置环境变量 CNB_API_TOKEN 以调用 CNB 的 API。每次更改环境变量后需要重新触发部署使变量生效。

手动部署

  1. Fork 本仓库
  2. EdgeOne Pages 控制台 创建新项目
  3. 连接你的 GitHub 仓库
  4. 设置构建配置:
    • 框架预设: Node.js (或不选,EdgeOne 会自动识别 edgeone.json)
    • 构建命令: (留空)
    • 输出目录: node-functions
  5. 点击部署

⚙️ 环境变量配置

本项目支持以下环境变量配置:

变量名描述是否必需默认值
CNB_API_TOKENCNB 平台访问令牌
PREFERRED_ORIGIN自定义部署域名(如 https://stats.example.com),用于生成首页的示例链接自动获取当前域名
CNB_API_BASE_URLCNB API 基础地址https://api.cnb.cool
TZ时区设置,影响日历等时间显示Asia/Shanghai

📊 功能特性

  • 徽章 (Badges):
    • Stars, Forks, Marks, Issues (Open/Closed/All)
    • Release (最新版本), Build (构建状态/进度/耗时)
    • Repo Size (仓库大小), License
    • Usage (Git/LFS 用量), CNB Version
  • 图表 (Charts):
    • Star History (星标历史)
    • Fork History, Issue History
    • Contributors Wall (贡献者墙)
    • Contribution Calendar (贡献日历)
  • 工具:
    • Random Image (随机仓库图片)
    • Health Check

🔗 API 使用指南

部署完成后,访问您的域名即可看到交互式文档页面。

通用参数

所有端点支持以下查询参数:

  • theme=light|dark|... - 主题配色
  • image_format=svg|png - 输出格式 (默认 svg)
  • interval=day|week|month - 聚合粒度;如未指定且提供了日期范围会自动推断
  • start_date=YYYY-MM-DD - 起始日期(含)
  • end_date=YYYY-MM-DD - 结束日期(含)

示例

<!-- Star History -->
![Star History](https://your-domain.edgeone.app/api/stars/cnb/cool)

<!-- 自定义日期范围与周粒度 -->
![Issues (Weekly)](https://your-domain.edgeone.app/api/issues/cnb/cool?start_date=2024-06-01&end_date=2024-12-31&interval=week)

<!-- Build Status -->
![Build Status](https://your-domain.edgeone.app/api/badge/build/status/cnb/cool)

<!-- Contribution Calendar -->
![Calendar](https://your-domain.edgeone.app/api/calendar/mintimate)

📦 项目结构

cnb-readme-stats-eo/
├── package.json              # 项目依赖
├── edgeone.json              # EdgeOne Pages 部署配置
└── node-functions/           # 云函数目录
    ├── index.js              # 首页引导逻辑
    ├── api/                  # API 路由定义
    └── src/                  # 核心业务逻辑
        ├── clients/          # CNB API 客户端
        ├── services/         # 徽章与图表生成服务
        └── ...

❤️ 致谢

本项目灵感来源于以下优秀项目:

📄 License

MIT

上游没有选择证书,如果后续上游项目(CommitCool)选择证书,将以他们的证书为准 ( ◔ ڼ ◔ )。

About

⚡ Dynamically generated stats for your CNB readmes.(Tencent EdgeOne Version)

CNBEdgeOnePagesNodeFunctionserverless
Language
JavaScript100%