Skip to content

Commit e469676

Browse files
committed
[DOCS, FIX] add fastkit startdemo template use-cases tutorial, add more specific clean up step at inspector
1 parent 5657e04 commit e469676

File tree

14 files changed

+6702
-7
lines changed

14 files changed

+6702
-7
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
<a href="https://github.com/bnbong/FastAPI-fastkit/releases" target="_blank">
1212
<img src="https://img.shields.io/github/v/release/bnbong/FastAPI-fastkit" alt="GitHub Release">
1313
</a>
14+
<a href="https://codecov.io/gh/bnbong/FastAPI-fastkit" >
15+
<img src="https://codecov.io/gh/bnbong/FastAPI-fastkit/graph/badge.svg?token=WS0B6WWD8K"/>
16+
</a>
1417
</p>
1518

1619
---

docs/index.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,31 @@ For comprehensive guides and detailed usage instructions, explore our documentat
292292
- 📖 **[CLI Reference](user-guide/cli-reference.md)** - Complete command reference
293293
- 🔍 **[Template Quality Assurance](reference/template-quality-assurance.md)** - Automated testing and quality standards
294294

295+
## 🚀 Template-based Tutorials
296+
297+
Learn FastAPI development through practical use cases with our pre-built templates:
298+
299+
### 📖 Core Tutorials
300+
301+
- **[Building a Basic API Server](tutorial/basic-api-server.md)** - Create your first FastAPI server using the `fastapi-default` template
302+
- **[Building an Asynchronous CRUD API](tutorial/async-crud-api.md)** - Develop a high-performance async API with the `fastapi-async-crud` template
303+
304+
### 🗄️ Database & Infrastructure
305+
306+
- **[Integrating with a Database](tutorial/database-integration.md)** - Utilize PostgreSQL + SQLAlchemy with the `fastapi-psql-orm` template
307+
- **[Dockerizing and Deploying](tutorial/docker-deployment.md)** - Set up a production deployment environment using the `fastapi-dockerized` template
308+
309+
### ⚡ Advanced Features
310+
311+
- **[Custom Response Handling & Advanced API Design](tutorial/custom-response-handling.md)** - Build enterprise-grade APIs with the `fastapi-custom-response` template
312+
- **[Integrating with MCP](tutorial/mcp-integration.md)** - Create an API server integrated with AI models using the `fastapi-mcp` template
313+
314+
Each tutorial provides:
315+
-**Practical Examples** - Code you can use directly in real projects
316+
-**Step-by-Step Guides** - Detailed explanations for beginners to follow easily
317+
-**Best Practices** - Industry-standard patterns and security considerations
318+
-**Extension Methods** - Guidance for taking your project to the next level
319+
295320
## Contributing
296321

297322
We welcome contributions from the community! FastAPI-fastkit is designed to help newcomers to Python and FastAPI, and your contributions can make a significant impact.

0 commit comments

Comments
 (0)