each-star.com

· 基于 Github API 和 Element Plus 的在线互助 Star 社区 ·

---

更酷炫且支持 Fork & Watch 的 EachStar2.0 正在开发中

如果您想参与讨论 EachStar， 欢迎加入：【QQ 群】

如果遇到任何问题(按照推荐程度优先级排序)

1. 在 github 提交新的 Issue
2. 给开发者发送邮件以咨询问题：
   • 前端：Littlelumos@foxmail.com
   • 后端：binlyliu@foxmail.com
3. 加入 QQ 群： 184109839 来面对面的和开发者反馈问题

如果你想要参与开发，则需要如下几点额外需求

1. 前端：对 vue3 以及 element-plus 的基本了解，要了解更多相关信息请看 【Vue.js 官方】 【element-plus 手册】
2. 后端：对 Koa 以及 node-postgres 的基础运用，要了解更多相关信息请看 【Koa 文档】 【node-postgres 手册】
3. 具有不依赖文档阅读代码的能力

开发环境配置

1. 克隆本项目
2. 访问：申请 GitHub OAuth APP，保留 GitHub 提供的 Id 和 Secret
3. 后端配置：
   1. 进入目录EachStar-backend
   2. 配置 postgres 数据库，命令参考createTables.sql
   3. 修改src/config.ts，配置 GitHubApp 和 数据库连接
   4. 执行yarn install安装依赖库
   5. 执行yarn start 开启本地开发环境
4. 前端配置：
   1. 进入目录EachStar-frontend
   2. 执行yarn install安装依赖库
   3. 执行npm run dev 开启本地开发环境
5. 如果以上步骤成功，访问您本地的开发环境：http://localhost:80

项目版本控制须知

本项目采用一个简单的 Git 分支模型：当您在进行开发的时候，请基于main创建新的分支，切勿直接基于master或者main分支进行开发，新的分支格式必须遵循dev/{user}/{qualifier}-{name}，{user}必须是您的用户名。

1. 如果新的代码包含的是BUG 修复，则{qualifier}必须为fix，{name}应当为 BUG 的简要叙述
2. 如果新的代码包含的是新功能，则{qualifier}必须为feat或者feature，{name}应当为新特性的简要叙述
3. 如果新的代码是重构或者代码质量提升，则{qualifier}必须为refactor，{name}应当为重构部分的简要叙述
4. 如果您的贡献包含不止一种上面提到的类型，则应当遵循和您的贡献最为相关的一项，并在 commit 信息中提及其他类型上的贡献
5. master分支必须当且仅当在新版本将要被发布的时候更新

在开发完成后，请在【这里】发布 Pull Request 请求合并到dev/main分支

项目结构

├── EachStar-backend/ -> 项目的后端主代码
├── EachStar-frontend/ -> 项目的前端主代码
├── imgs/
├── .gitignore
├── README.md
└── LICENSE

鸣谢

• @moyeyuexiao

特别鸣谢 Star 过本项目的支持者们...
(以下列表实时更新，排名不分先后)