gh-latest-repos 项目教程

35 0 0

gh-latest-repos 项目教程

gh-latest-reposMicroservice to get the latest public GitHub repos from a user项目地址:https://gitcode.com/gh_mirrors/gh/gh-latest-repos

1. 项目的目录结构及介绍

gh-latest-repos 项目的目录结构如下：

gh-latest-repos/ ├── .env.example ├── .gitignore ├── README.md ├── index.js ├── package.json └── vercel.json

.env.example: 环境变量示例文件，包含项目所需的环境变量配置。
.gitignore: Git 忽略文件，指定不需要版本控制的文件和目录。
README.md: 项目说明文档，包含项目的基本信息和使用说明。
index.js: 项目的入口文件，负责启动和配置服务。
package.json: Node.js 项目的配置文件，包含项目的依赖和脚本命令。
vercel.json: Vercel 部署配置文件，用于配置项目的部署选项。

2. 项目的启动文件介绍

项目的启动文件是 index.js，它是整个微服务的入口点。以下是 index.js 的主要内容和功能介绍：


const express = require('express');
const { createClient } = require('@vercel/kv');
const { getLatestRepos } = require('./lib/github');
 
const app = express();
const client = createClient({
  url: process.env.KV_URL,
  token: process.env.KV_TOKEN,
});
 
app.get('/', async (req, res) => {
  const username = req.query.username;
  if (!username) {
    return res.status(400).send('Missing username');
  }
 
  const cachedRepos = await client.get(username);
  if (cachedRepos) {
    return res.json(JSON.parse(cachedRepos));
  }
 
  const repos = await getLatestRepos(username);
  await client.set(username, JSON.stringify(repos), 'EX', 86400);
  res.json(repos);
});
 
const port = process.env.PORT || 3000;
app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

引入依赖: 引入了 express、@vercel/kv 和自定义的 getLatestRepos 函数。
创建 Express 应用: 使用 express 创建一个应用实例。
配置 KV 客户端: 使用 @vercel/kv 创建一个客户端实例，用于缓存数据。
定义路由: 定义了一个 GET 路由，用于获取指定用户的最新仓库。
缓存处理: 检查缓存中是否有数据，如果有则直接返回，否则调用 getLatestRepos 获取数据并缓存。
启动服务: 监听指定端口，启动服务。

3. 项目的配置文件介绍

.env.example

.env.example 文件是一个环境变量配置示例，包含项目运行所需的环境变量。实际使用时，需要将 .env.example 复制为 .env 并填入实际的值。


GITHUB_TOKEN=your_github_token
GITHUB_USERNAME=your_github_username
ACCESS_ALLOW_ORIGIN=your_website_url
MAX_REPOS=6

GITHUB_TOKEN: GitHub 个人访问令牌，用于访问 GitHub API。
GITHUB_USERNAME: 要获取仓库的用户名。
ACCESS_ALLOW_ORIGIN: 允许的跨源请求 URL，用于设置 Access-Control-Allow-Origin 头。
MAX_REPOS: 返回的仓库数量，默认为 6。

vercel.json

vercel.json 文件是 Vercel 部署配置文件，用于配置项目的部署选项。


{
  "env": {
    "GITHUB_TOKEN": "@github_token",
    "GITHUB_USERNAME": "@github_username",
    "ACCESS_ALLOW_ORIGIN": "*",
    "MAX_REPOS": "6"
  }
}