GitHub贡献图表服务使用教程

#GitHub贡献图表服务使用教程

ssr-contributions-img Server side rendering of Github contribution wall API 项目地址: https://gitcode.com/gh_mirrors/ss/ssr-contributions-img

1. 项目介绍

本项目是基于GitHub API的Nest.js API服务，用于生成GitHub用户的贡献图表。图表可以以不同的类型展示，如日历视图或3D柱状图，并提供多种定制化选项，包括图表格式、颜色、质量、大小等。

2. 项目快速启动

准备工作

• 确保您已经安装了Node.js环境。
• 准备一个GitHub Personal Access Token用于API认证。

安装步骤

1. 克隆项目到本地：

   git clone https://github.com/CatsJuice/ssr-contributions-img.git
   

2. 在项目根目录创建一个.env文件，并添加以下内容（将YOUR_GITHUB_TOKEN替换为您的GitHub Personal Access Token）：

   GITHUB_TOKEN=YOUR_GITHUB_TOKEN
   

3. 安装项目依赖：

   npm install
   

   或者使用Yarn：

   yarn install
   

4. 启动服务：

   npm run start:dev
   

   或者使用Yarn：

   yarn start:dev
   

使用示例

启动服务后，您可以通过以下URL访问您的贡献图表：

http://localhost:3000/_/<username>

将<username>替换为您的GitHub用户名。

3. 应用案例和最佳实践

定制化图表

您可以通过添加查询参数来定制图表。例如，要获取SVG格式的日历视图图表，可以使用以下URL：

http://localhost:3000/_/<username>?chart=calendar&format=svg

要使用3D柱状图，并启用暗色模式，可以这样：

http://localhost:3000/_/<username>?chart=3dabar&format=svg&dark=true

集成到其他应用

您可以将此服务集成到其他应用中，例如在Notion或iOS小组件中显示图表。

4. 典型生态项目

目前，本项目已经支持多种类型的图表展示，并且社区中也有其他开发者在使用此服务构建各种有趣的应用，例如GitHub贡献统计页面、个人博客的贡献图表展示等。

本项目持续更新，期待更多开发者的加入和贡献，共同丰富GitHub贡献图表服务的生态系统。

ssr-contributions-img Server side rendering of Github contribution wall API 项目地址: https://gitcode.com/gh_mirrors/ss/ssr-contributions-img