https://github.com/sparticleinc/gptbase-enterprise-server
https://github.com/sparticleinc/gptbase-enterprise-server
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/sparticleinc/gptbase-enterprise-server
- Owner: sparticleinc
- Created: 2023-11-09T06:16:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-30T13:20:38.000Z (almost 2 years ago)
- Last Synced: 2025-02-26T13:46:25.618Z (over 1 year ago)
- Language: Python
- Size: 99.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 服务开发指南
## 一、框架说明
### 1.1 Python>=3.10
### 1.2 [FastAPI](https://fastapi.tiangolo.com/zh/) WEB框架
### 1.3 [Tortoise-ORM](https://tortoise.github.io/contrib/fastapi.html) 数据库ORM【使用PostgreSQL数据库】
### 1.4 uvicorn 服务运行库
## 二、快速开始
- 安装Python 3.10
- 拉取代码
- 设置python虚拟环境
- `pip install virtualenv`
- `virtualenv venv`
- 安装依赖 `pip install -r requirements.txt`
- 安装vscode，并安装扩展pylance
- 在项目根目录下创建.env，对应setting.py里面的配置
- 运行代码：`uvicorn circleo.app:app --reload` 或者 `python main.py`
- 安装pre-commit，执行：`pip install pre-commit`以及`pre-commit install`用于提交代码前格式检查
## 三、代码提交规范
- 新功能开发、较大改动的bug以及代码重构需要通过开分支提交，并请求其他成员进行代码review以及合并。通过github pull request
提交合并请求。
- 分支说明
- main分支为开发环境分支，最新代码在main分支体现
- 合并到main分支前需要先解决代码冲突，由请求合并方负责冲突解决
- 正式版本将代码从main分支开出最新的wk分支（如果一周多个发布，则为合并）
## 四、运维说明
### 4.1 环境说明
### 4.2 服务部署
### 4.3 运行日志
> 通过elastic查看
## 五、ORM生成初始化脚本
- Init ORM: `aerich init -t gptbase_enterprise.settings.TORTOISE_ORM` (Only fisrt, no need)
- Init database: `aerich init-db` (Only fisrt, no need)
- Make migrations: `aerich migrate`
- Migrate(to DB): `aerich upgrade`
- 注意：如果是同一功能的提交，尽量只使用一个sql脚本
- 小技巧：如果已经使用`aerich migrate`并进行了`aerich upgrade`。可以使用`aerich downgrade`
回退版本，然后再进行`aerich migrate`以及`aerich upgrade`
## 六、国际化
### 6.1 翻译使用规范
## 七、EMQ事件通知
## 八、程序结构说明
## 九、HTTP 返回码
- 200 OK 接口请求正常
- 204 No Content 接口请求正常，但是服务器没有返回数据
- 400 Bad Request 客户端请求参数错误，例如，指定数字类型但是传入的是字符串
- 401 Unauthorized 没有登录授权
- 403 Forbidden 没有权限
- 404 Not Found 资源或接口不存在
- 405 Method Not Allowed 请求方式错误
- 422 Unprocessable Entity 请求参数格式错误
- 500 Internal Server Error 服务器错误，未处理异常