更酷炫且支持 Fork & Watch 的 EachStar2.0 正在开发中
如果您想参与讨论 EachStar, 欢迎加入:【QQ 群】
- 在 github 提交新的 Issue
- 给开发者发送邮件以咨询问题:
- 加入 QQ 群: 184109839 来面对面的和开发者反馈问题
- 前端:对 vue3 以及 element-plus 的基本了解,要了解更多相关信息请看 【Vue.js 官方】 【element-plus 手册】
- 后端:对 Koa 以及 node-postgres 的基础运用,要了解更多相关信息请看 【Koa 文档】 【node-postgres 手册】
- 具有不依赖文档阅读代码的能力
- 克隆本项目
- 访问:申请 GitHub OAuth APP,保留 GitHub 提供的 Id 和 Secret
- 后端配置:
- 进入目录
EachStar-backend
- 配置 postgres 数据库,命令参考
createTables.sql
- 修改
src/config.ts
,配置 GitHubApp 和 数据库连接 - 执行
yarn install
安装依赖库 - 执行
yarn start
开启本地开发环境
- 进入目录
- 前端配置:
- 进入目录
EachStar-frontend
- 执行
yarn install
安装依赖库 - 执行
npm run dev
开启本地开发环境
- 进入目录
- 如果以上步骤成功,访问您本地的开发环境:
http://localhost:80
本项目采用一个简单的 Git 分支模型:当您在进行开发的时候,请基于main
创建新的分支,切勿直接基于master
或者main
分支进行开发,新的分支格式必须遵循dev/{user}/{qualifier}-{name}
,{user}
必须是您的用户名。
- 如果新的代码包含的是BUG 修复,则
{qualifier}
必须为fix
,{name}
应当为 BUG 的简要叙述 - 如果新的代码包含的是新功能,则
{qualifier}
必须为feat
或者feature
,{name}
应当为新特性的简要叙述 - 如果新的代码是重构或者代码质量提升,则
{qualifier}
必须为refactor
,{name}
应当为重构部分的简要叙述 - 如果您的贡献包含不止一种上面提到的类型,则应当遵循和您的贡献最为相关的一项,并在 commit 信息中提及其他类型上的贡献
master
分支必须当且仅当在新版本将要被发布的时候更新
在开发完成后,请在【这里】发布 Pull Request 请求合并到dev/main
分支
├── EachStar-backend/ -> 项目的后端主代码
├── EachStar-frontend/ -> 项目的前端主代码
├── imgs/
├── .gitignore
├── README.md
└── LICENSE
特别鸣谢 Star 过本项目的支持者们...
(以下列表实时更新,排名不分先后)