:octocat: A tool that generates a repository which being pushed into your GitHub account creates a nice contributions calendar.
$ gh-contributions
一款生成仓库的工具,将其推送到您的 GitHub 账户后,可创建精美的贡献日历。
安装
全局安装
确保您已配置 NPM 和 NodeJS,无需 sudo 即可全局安装包。
$ npm i -g gh-contributions
要启动 GitHub 贡献服务器,请执行以下操作:
$ gh-contributions
Windows 系统安装注意事项
为确保本应用在 Windows 上正常运行,安装 Git 时需勾选“将 Git 添加到系统 PATH 环境变量”选项,如下图所示:

若未启用此选项,gh-contributions 将无法生成代码仓库。
本地安装指南
$ git clone git@github.com:IonicaBizau/github-contributions.git
$ cd github-contributions
$ npm i
$ npm start
使用说明
服务器运行在 9000 端口。请在浏览器中访问 http://localhost:9000/。
启动应用后,您可以在应用页面 (http://localhost:9000) 查看帮助信息。
在 Docker 容器中运行服务器
注意:若要在 Docker 中运行,需使用低于 3.0.0 的版本。当前版本已不再支持此功能。
本地构建 Docker 容器:
docker build -t github-contributions .
启动 Docker 容器:
docker run --rm -it -p 127.0.0.1:9000:9000 --name=github-contributions-server github-contributions
在浏览器中打开 http://localhost:9000/。
❓ 获取帮助
有几种方式可以获取帮助:
- 请在 Stack Overflow 上提问。只要附上 Stack Overflow 问题的链接,你也可以通过提交 issue 来提问。
- 报告错误或请求新功能,请直接提交 issue。🐛
- 如需即时一对一帮助,可以 使用 Codementor 平台。🚀
😋 如何参与贡献
有想法?发现了问题?查看贡献指南。
💖 支持我的项目
我尽可能开源所有作品,并尽力帮助使用这些项目的用户。显然,这需要大量时间。你可以免费将这些项目集成到你的应用中!甚至可以修改源码并重新分发(包括商用)。
但如果你因此获益或想鼓励我继续创作,可以通过以下方式支持:
-
为喜欢的项目加星并分享 🚀
-
比特币——可向此地址转账(或扫描下方二维码):
1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6
感谢!❤️
💫 哪些项目在使用本库?
如果你的项目使用了本库,请在此添加。✨
auto-contribution

