tyvekzhang / fastapi-sqlmodel-starter

One of the best scaffolding in the PyWeb field.

Hi, 👋 I'm tyvekZhang

• 🔭 I'm a passionate software developer with dreams of changing the world.
• 💡 I have a strong interest in automation, containerization, system architecture, and AI.
• 📫 Please feel free to email me if you have any questions: [email protected].

Languaues and Tools

My GitHub Contributions

My GitHub Stats

fastapi-sqlmodel-starter's Issues

用户登录功能

用户导入,导出功能

添加ISSUE_TEMPLATE文件

添加CONTRIBUTING文件

docker部署

添加项目探针

添加license文件

添加github的workflows配置

What would you like to be added(你想添加什么功能)?

代码合并前做检查, 校验

Requirement reference(功能、界面参考的文档或链接)?

https://github.com/flutter/flutter/tree/master/.github/workflows
https://github.com/freeCodeCamp/freeCodeCamp/tree/main/.github/workflows
https://github.com/microsoft/TypeScript/tree/main/.github/workflows

Acceptance Criteria(验收标准)

项目构建：你可以设置在每次提交或者在特定条件下自动运行编译和构建代码。
自动测试：在每次提交代码、创建或更新 Pull Request 的时候自动运行测试，保证代码的质量。
自动部署：当代码推送到特定分支或者新的 Release 生成时，自动将代码部署到预设的环境中。
代码格式检查：在创建或更新 Pull Request 的时候自动运行例如 ESLint, Prettier 等工具对代码格式进行检查。
自动生成文档：当代码更新时，自动更新对应的 API 文档。
发布管理：使用 GitHub Workflow 可以自动将项目软件发布到 GitHub Releases，或者发布到 npm, docker hub等平台。
异常通知：在工作流程运行出错的时候，通过邮件或其他方式警告相关人员。
标签管理：当 Pull Request 通过或者 Issue 关闭时，可以自动添加或删除对应的标签。

用户注册功能

添加PULL_REQUEST_TEMPLATE文件

What would you like to be added(你想添加什么功能)?

添加pull request的模板文件, 做到提交信息统一, 方便追踪

Requirement reference(功能、界面参考的文档或链接)?

1. https://github.com/kubernetes/kubernetes/blob/master/.github/PULL_REQUEST_TEMPLATE.md
2. https://github.com/ant-design/ant-design/blob/master/.github/PULL_REQUEST_TEMPLATE.md

Acceptance Criteria(验收标准)

• 文件位置：.github 目录下
• 文件名：PULL_REQUEST_TEMPLATE.md
• 文件内容：参考提供的模板链接, 完成后投票决定是否Ok

本地缓存功能

添加pgsql数据库

角色相关功能

添加pyproject.tom和pre-commit文件

What would you like to be added(你想添加什么功能)?

添加pyproject.tom和pre-commit文件

Requirement reference(功能、界面参考的文档或链接)?

1. https://github.com/tox-dev/tox/tree/main
2. https://github.com/psf/requests/tree/main
3. https://github.com/pytest-dev/pytest

Acceptance Criteria(验收标准)

1. 能够安装fastapi依赖
2. 能够执行pre-commit
3. py-test测试通过

添加CODE_OF_CONDUCT文件

说明文档

redis缓存功能

测试fastapi功能

添加数据库脚本迁移

添加fastapi组件

JWT认证功能

项目初始化

添加mysql数据库

添加SECURITY文件

项目结构初始化

添加sqllite数据库

k8s部署

异步消息功能

添加readme文件