Github-Rank项目设计文档​

2024年11月7日修改
前端：刘慧涛, 项久桢​
后端:   严杰​
一. 项目介绍​
GithubRank是一个面向开发者和用户的 Web 应用。它主要用于追踪和分析与代码开发相关的各种指标，帮助开发者更好地了解自己的工作效率、代码质量等情况，同时也帮助用户寻找github活跃的开发者，也可以通过查找和筛选选择自己喜欢的开发者，并且可以表达对开发者的认可度和对开发者的评价​
i.
前端使用了Vue3和Ts语言开发，除了推荐页，登录，AI评论等众多基础功能之外， GithubRank还提供了国际化、黑白背景等特色功能，提高了功能的完备性。​
ii.
后端部分使用Python语言微服务框架，Nacos实现服务发现与作为配置中心，Gateway网关实现路由转发，Swagger生成API文档，MySQL进行持久化，实现服务之间的解耦和路由的负载均衡。​
项目demo：https://www.bilibili.com/video/BV15eDQYuEsa/?spm_id_from=333.999.0.0&vd_source=96f911a3bb7b1b2808b2794a5dd4d544​
二. 项目运行​
◦
api接口(apifox版本) https://apifox.com/apidoc/shared-c95ac23f-0e5d-44e9-a8d4-ffe7d96184fa​
◦
后端项目运行配置 ​Github-Rank项目后端运行配置​
◦
前端运行：https://github.com/qiushui7/githubRank/blob/main/README.md​
三. 实现的业务需求​
1.
用户模块​
◦
用户的登陆​
◦
用户对开发者进行评价​
◦
获取开发者的用户评价​
2.
推荐模块​
◦
推荐 月/星期/日 热门开发者​
3.
信息模块​
◦
获取单个开发者信息​
◦
获取单个开发者所有repo​
◦
获取单个开发者所有issue​