本文档提供了 GitHub Readme Stats 开发环境设置的详细说明。它涵盖了在本地运行项目所需的先决条件、安装步骤和配置。有关测试系统的详细信息，请参阅测试系统。
在设置开发环境之前，请确保您已安装以下软件：
来源：package.json CONTRIBUTING.md31
本项目使用 Vercel 进行开发和部署。请使用 npm 全局安装 Vercel CLI：
使用 npm 安装所有必需的依赖项：
这将安装 `package.json` 文件中定义的运行时依赖项（如 axios, dotenv）和开发依赖项（如 Jest, ESLint）。
来源：CONTRIBUTING.md35 package.json38-70
在项目根目录下运行 vercel 命令，并按照交互式步骤将项目链接到您的 Vercel 账户。
在设置过程中，Vercel 会询问一些关于项目配置的问题。除非您需要自定义配置，否则请使用默认值。
使用以下命令启动本地开发服务器：
这将启动一个开发服务器，地址为 http://:3000，您可以在本地测试 API 端点。
来源：package.json CONTRIBUTING.md38-41
该项目包含多个 npm 脚本，您可以在开发过程中使用它们：
| 脚本 | 描述 |
|---|---|
npm test | 使用 Jest 运行所有测试 |
npm run test:watch | 在监视模式下运行测试 |
npm run test:e2e | 运行端到端测试 |
npm run format | 使用 Prettier 格式化代码 |
npm run lint | 使用 ESLint 检查代码 |
npm run theme-readme-gen | 生成主题文档 |
npm run preview-theme | 预览主题 |
来源：package.json
启动开发服务器后，您可以通过以下地址访问本地 API 端点：
http://:3000/api?username=anuraghazrahttp://:3000/api/pin?username=anuraghazra&repo=github-readme-statshttp://:3000/api/top-langs?username=anuraghazrahttp://:3000/api/wakatime?username=anuraghazrahttp://:3000/api/gist?id=<gist_id>Visual Studio Code 是推荐的开发 IDE。该项目包含 VS Code 的配置文件，以帮助进行调试和开发。
来源：CONTRIBUTING.md40-41 .vscode/extensions.json
项目推荐以下 VS Code 扩展：
dbaeumer.vscode-eslint）：用于代码检查esbenp.prettier-vscode）：用于代码格式化yzhang.markdown-all-in-one）：用于编辑 Markdown 文件这些扩展列在 .vscode/extensions.json 文件中，当您在 VS Code 中打开项目时，它们会被建议安装。
您可以使用以下方式在 VS Code 中调试代码：
要设置调试：
项目使用环境变量进行配置。在根目录中创建一个 .env 文件，并包含以下变量：
PAT_1=your_github_personal_access_token
此令牌用于在开发期间增加 GitHub API 请求的速率限制。您可以从 GitHub 帐户设置中生成个人访问令牌。
注意：.env 文件已包含在 .gitignore 中，以防止意外提交敏感信息。
项目使用 Husky 来运行 pre-commit 钩子，以确保代码质量。
这有助于维护代码质量，并确保代码在提交前通过测试。
来源：.husky/pre-commit1-3 package.json32
对于主题开发，请使用以下脚本：
npm run theme-readme-gen：生成主题文档npm run preview-theme：预览主题注意：如 CONTRIBUTING.md 文件所述，添加新主题目前已暂停。
来源: package.json26-27 CONTRIBUTING.md43-48
要贡献翻译，请编辑 src/translations.js 文件。您可以使用本地开发服务器测试更改。