OpenTeens社区后端项目是由OpenTeensCore团队开发的,旨在为前端提供必要的API接口和技术支持。本项目基于Go语言和Gin框架,以提供高效、稳定和易扩展的服务。
确保您的开发环境中安装了以下软件:
- Go (版本1.15或更高)
- Git
- 任何Go语言支持的IDE(推荐使用Visual Studio Code或GoLand)
- 打开终端或命令提示符。
- 运行以下命令来克隆项目仓库:
git clone https://github.com/OpenTeensCore/openteens-backend.git- 进入项目目录:
cd openteens-backend在项目根目录下,执行以下命令来启动项目:
go run main.go这将启动服务器,默认监听在localhost:8080。您可以通过访问http://localhost:8080来测试是否成功运行。
建议使用Visual Studio Code或GoLand作为开发IDE,它们提供了良好的Go语言支持和便捷的调试工具。
/docs- 存放文档/controller- 存放路由处理函数/services- 业务逻辑处理(被controller层调用)【待重构】/model- 数据模型/middleware- 中间件/utils- 工具函数/dao- 数据库相关配置/router- 路由配置
- 在
/controller目录和/service目录下创建相应的文件。 - 定义路由和处理函数。
- 在
/router中注册新的路由。
请遵循Go代码评审标准来保持代码质量。
经过讨论,commit消息使用
创建分支的时候请遵循分支分类+名称的命名规则,如feat/sqlite。如果有很多修改可以用名字/分类-名称的方式,如lanbinshijie/sqlite。这些分支名经过测试都是合法的。
为了提高项目的可维护性,请遵循以下Git提交信息规范:
- 功能添加:
feat: 添加了新的登录功能 - 问题修复:
fix: 修复了用户认证bug - 文档更新:
docs: 更新了README文件 - 性能优化:
perf: 优化了数据库查询效率 - 代码重构:
refactor: 重构了用户服务模块或ref: 重构了用户服务模块 - 测试代码:
test: 添加了新的API测试用例
欢迎通过Pull Requests或Issue来贡献您的智慧。在提交PR之前,请确保您的代码符合上述开发和Git提交规范。