Skip to content

Commit f6adfe4

Browse files
author
JiayuXu
committed
docs: 更新README添加create-fastapi-app脚手架说明
添加关于新脚手架工具create-fastapi-app的详细介绍和使用方法 移除旧的快速开始步骤,推荐使用新脚手架工具 更新项目支持部分,添加脚手架项目的Star呼吁
1 parent d3650db commit f6adfe4

1 file changed

Lines changed: 78 additions & 3 deletions

File tree

README.md

Lines changed: 78 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,58 @@ evoai-backend-template/
152152

153153
## 🚀 快速开始
154154

155-
### 1. 环境准备
155+
### ⚡ 一键创建项目 (推荐)
156+
157+
**🎉 全新脚手架工具 `create-fastapi-app` 已发布!**
158+
159+
<div align="center">
160+
161+
<a href="https://github.com/JiayuXu0/create-fastapi-app" target="_blank">
162+
<img src="https://img.shields.io/badge/🚀_create--fastapi--app-一键创建FastAPI项目-00D8FF?style=for-the-badge&logo=fastapi&logoColor=white&labelColor=009688&color=00D8FF" alt="create-fastapi-app">
163+
</a>
164+
165+
<a href="https://github.com/JiayuXu0/create-fastapi-app" target="_blank">
166+
<img src="https://img.shields.io/badge/⭐_Star项目-支持开发-FFD700?style=for-the-badge&logo=github&logoColor=white&labelColor=FF6B6B&color=FFD700" alt="Star create-fastapi-app">
167+
</a>
168+
169+
**⭐ 如果觉得有用,请给 [create-fastapi-app](https://github.com/JiayuXu0/create-fastapi-app) 点个 Star 支持一下!⭐**
170+
171+
</div>
172+
173+
```bash
174+
# 🚀 使用 npx (推荐)
175+
npx create-fastapi-app@latest my-awesome-backend
176+
177+
# 🚀 使用 npm
178+
npm create fastapi-app@latest my-awesome-backend
179+
180+
# 🚀 使用 yarn
181+
yarn create fastapi-app my-awesome-backend
182+
183+
# 🚀 使用 pnpm
184+
pnpm create fastapi-app my-awesome-backend
185+
```
186+
187+
**✨ 脚手架优势:**
188+
- 🎯 **交互式创建** - 友好的命令行界面,一步步引导配置
189+
- 🔧 **智能配置** - 自动生成 `.env` 文件和数据库配置
190+
- 📦 **模板丰富** - 基础版、完整版、微服务版等多种选择
191+
- 🚀 **开箱即用** - 生成后立即可运行,零配置启动
192+
- 🛠️ **工具集成** - 预配置代码检查、格式化、测试等开发工具
193+
194+
> 💡 **强烈推荐使用脚手架工具!比手动配置快 10 倍!**
195+
>
196+
> 🔗 **项目地址**https://github.com/JiayuXu0/create-fastapi-app
197+
>
198+
> **别忘了给脚手架项目点个 Star 哦!你的支持是我们持续改进的动力!**
199+
200+
---
201+
202+
### 💻 手动安装 (传统方式)
203+
204+
如果你更喜欢手动配置或需要深度自定义:
205+
206+
#### 1. 环境准备
156207

157208
```bash
158209
# 安装UV包管理器
@@ -565,6 +616,17 @@ git commit --no-verify -m "urgent fix"
565616
</div>
566617

567618
### 🚀 快速上手
619+
620+
**🎯 方式一:脚手架创建 (推荐)**
621+
```bash
622+
npx create-fastapi-app@latest my-project
623+
cd my-project && uv run uvicorn src:app --reload
624+
# 🎉 2分钟内即可启动完整的企业级后端服务!
625+
```
626+
627+
**⭐ 别忘了给脚手架点 Star:https://github.com/JiayuXu0/create-fastapi-app**
628+
629+
**📦 方式二:模板克隆**
568630
```bash
569631
curl -LsSf https://astral.sh/uv/install.sh | sh
570632
git clone https://github.com/JiayuXu0/FastAPI-Template.git
@@ -596,12 +658,25 @@ uv run aerich init-db && uv run uvicorn src:app --reload
596658

597659
### 🚀 支持项目发展
598660

599-
如果这个项目对你有帮助,请给我们一个Star⭐
661+
#### ⭐ 给模板项目点个 Star
662+
如果这个模板对你有帮助,请给我们一个Star⭐
600663

601664
<a href="https://github.com/JiayuXu0/FastAPI-Template" target="_blank">
602-
<img src="https://img.shields.io/badge/⭐_立即Star-支持项目-FFD700?style=for-the-badge&logo=github&logoColor=white&labelColor=FF6B6B&color=FFD700" alt="立即Star">
665+
<img src="https://img.shields.io/badge/⭐_立即Star-支持模板-FFD700?style=for-the-badge&logo=github&logoColor=white&labelColor=FF6B6B&color=FFD700" alt="立即Star模板">
603666
</a>
604667

668+
#### 🚀 也别忘了 create-fastapi-app 脚手架
669+
**更重要的是,也给我们的脚手架工具点个 Star!**
670+
671+
<a href="https://github.com/JiayuXu0/create-fastapi-app" target="_blank">
672+
<img src="https://img.shields.io/badge/⭐_Star脚手架-create--fastapi--app-00D8FF?style=for-the-badge&logo=fastapi&logoColor=white&labelColor=009688&color=00D8FF" alt="Star脚手架">
673+
</a>
674+
675+
**🎯 为什么要 Star 脚手架项目?**
676+
- 🚀 让更多开发者发现这个便利工具
677+
- 💪 激励我们持续改进和添加新功能
678+
- 🌟 你的支持是开源项目发展的动力
679+
605680
</div>
606681

607682
[![GitHub Discussions](https://img.shields.io/github/discussions/JiayuXu0/FastAPI-Template?color=blue&logo=github)](https://github.com/JiayuXu0/FastAPI-Template/discussions)

0 commit comments

Comments
 (0)