profile-summary-for-github README

The project's README from github.com/tipsy/profile-summary-for-github. As one markdown file: README.md.

Profile Summary   Badge License

A tool to visualize your GitHub presence.



Button Demo    Button Building    Button Usage 



profile-summary-for-github (tipsy/profile-summary-for-github)

Searching Database…

这是什么?一个展示你 GitHub 形象的可视化工具:它把 GitHub 个人主页变成一个可视化的摘要页面,而不是默认的普通主页视图。
它是托管好的网站,还是需要我自己部署运行?两种方式都有:这是一个可以自己部署的 Web 应用——后端用 Kotlin 编写、基于 Javalin 框架,在浏览器里提供 Vue 前端页面。
我该怎么把它跑起来?仓库自带 Docker 支持,所以最快的方式就是以容器方式运行;从源码构建的步骤在 Documentation/Building.md 里有说明。
除了 Docker 之外还需要装别的东西吗?不需要——它是一个独立的 Web 服务,没有需要另外安装的客户端;服务器启动后,你用浏览器打开就行了。
它能在我的电脑上跑吗,还是必须要正式的服务器?都可以:后端是一个 JVM 应用,只要能跑 Docker 或 Java 的地方就能运行——笔记本、家庭服务器或 VPS 都行,界面就是一个普通的网页。
它可视化展示的数据是从哪里来的?直接通过 API 从 GitHub 获取——这个项目就是基于 GitHub API 构建的,所以它总结的是你线上的 GitHub 主页,而不是扫描你本地的仓库。
自己部署之前,有没有在线演示可以先看看?有——README 的开头就在 Building 和 Usage 文档旁边放了一个 Demo 按钮,你可以在安装任何东西之前先预览一下渲染出来的个人主页效果。
Creator
tipsy
Size
3.2 MB
Stars
19.9K
Updated
CommitFeb 22
Age
8y
Commits · 90 Days