Skip to content

Commit 3e26b1d

Browse files
wu-clanwu-clan
committed
update docs
1 parent 9f9bae2 commit 3e26b1d

File tree

8 files changed

+44
-79
lines changed

8 files changed

+44
-79
lines changed

‎docs/.vuepress/components/PluginMarket.vue

Lines changed: 8 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
type="text"
77
placeholder="🔍 搜索插件..."
88
class="search-input"
9-
@input="filterPlugins"
109
/>
1110
</div>
1211
<div class="plugin-card-container">
@@ -28,11 +27,10 @@
2827
<Icon :name="item.icon" size="5em" color="var(--vp-c-text-1)" />
2928
</div>
3029
<div
31-
v-if="item.priceLabel"
32-
class="price-corner-tag"
33-
:class="{ 'paid': item.priceLabel === '付费' }"
30+
v-if="item.free?.valueOf() === false"
31+
class="price-corner-tag paid"
3432
>
35-
<span class="price-corner-text">{{ item.priceLabel }}</span>
33+
<span class="price-corner-text">付费</span>
3634
</div>
3735
</div>
3836
<div class="card-content">
@@ -47,9 +45,7 @@
4745
rel="noopener noreferrer"
4846
aria-label="GitHub仓库"
4947
@click.stop
50-
>
51-
<Icon name="mdi:github" color="var(--vp-c-text-2)" />
52-
</a>
48+
/>
5349
<span v-else class="built-in-label-inline">内置</span>
5450
</div>
5551
</div>
@@ -77,7 +73,7 @@ export interface PluginItem {
7773
tags: string[]
7874
link?: string
7975
image?: string
80-
priceLabel?: '免费' | '付费'
76+
free?: boolean
8177
}
8278
8379
const props = withDefaults(
@@ -104,8 +100,8 @@ const filteredItems = computed(() => {
104100
})
105101
106102
const colors = {
107-
'MySQL': { color: '#006484', backgroundColor: 'rgba(0, 100, 132, 0.1)', borderColor: 'rgba(0, 100, 132, 0.2)' },
108-
'PostgreSQL': {
103+
'mysql': { color: '#006484', backgroundColor: 'rgba(0, 100, 132, 0.1)', borderColor: 'rgba(0, 100, 132, 0.2)' },
104+
'pgsql': {
109105
color: '#336699',
110106
backgroundColor: 'rgba(51, 102, 153, 0.1)',
111107
borderColor: 'rgba(51, 102, 153, 0.2)'
@@ -149,7 +145,6 @@ const handleCardClick = (item: PluginItem) => {
149145
150146
.plugin-card.clickable:hover {
151147
transform: translateY(-2px);
152-
box-shadow: 0 6px 16px rgba(0, 0, 0, 0.08);
153148
border-color: var(--vp-c-brand);
154149
}
155150
@@ -166,7 +161,6 @@ const handleCardClick = (item: PluginItem) => {
166161
display: flex;
167162
align-items: center;
168163
justify-content: center;
169-
border-bottom: 1px solid var(--vp-c-divider);
170164
}
171165
172166
.image-content {
@@ -225,10 +219,6 @@ const handleCardClick = (item: PluginItem) => {
225219
font-size: 1.5rem
226220
}
227221
228-
.no-external-icon::after {
229-
content: none !important;
230-
}
231-
232222
.built-in-label-inline {
233223
font-size: 0.75rem;
234224
color: var(--vp-c-text-2);
@@ -251,8 +241,7 @@ const handleCardClick = (item: PluginItem) => {
251241
.card-tags {
252242
display: flex;
253243
flex-wrap: wrap;
254-
align-items: center;
255-
gap: 0.4rem;
244+
gap: 0.2rem;
256245
}
257246
258247
.price-corner-tag {
@@ -269,10 +258,6 @@ const handleCardClick = (item: PluginItem) => {
269258
z-index: 1;
270259
}
271260
272-
.price-corner-tag {
273-
background: #17bf63;
274-
}
275-
276261
.price-corner-tag.paid {
277262
background: #ff5733;
278263
}

‎docs/.vuepress/components/Pricing.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<div class="pricing-container">
33
<h1 class="pricing-title">选择适合您的版本</h1>
44
<p class="pricing-subtitle">
5-
所有版本均无商业性质<br>
5+
所有版本均无商业授权性质<br>
66
<span style="color: #fd7600;">
77
此仓库作为模板库公开，任何个人或企业均可自由使用！
88
</span>

‎docs/.vuepress/data/plugin.ts

Lines changed: 25 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -5,97 +5,85 @@ export const pluginItems: PluginItem[] = [
55
icon: "fa6-regular:file-code",
66
title: "代码生成",
77
description: "生成通用业务代码（仅后端工程）",
8-
tags: ["MySQL", "PostgreSQL", "后端"],
9-
priceLabel: "免费"
8+
tags: ["mysql", "pgsql", "后端"]
109
},
1110
{
1211
icon: "fe:notice-active",
1312
title: "通知公告",
1413
description: "发布系统内部通知、公告",
15-
tags: ["MySQL", "PostgreSQL", "后端"],
16-
priceLabel: "免费"
14+
tags: ["mysql", "pgsql", "后端"]
1715
},
1816
{
1917
icon: "fluent-mdl2:dictionary",
2018
title: "数据字典",
2119
description: "通常用于约束前端工程数据展示",
22-
tags: ["MySQL", "PostgreSQL", "后端"],
23-
priceLabel: "免费"
20+
tags: ["mysql", "pgsql", "后端"]
2421
},
2522
{
2623
icon: "icon-park-outline:config",
2724
title: "参数配置",
2825
description: "通常用于前端工程数据展示",
29-
tags: ["MySQL", "PostgreSQL", "后端"],
30-
priceLabel: "免费"
26+
tags: ["mysql", "pgsql", "后端"]
3127
},
3228
{
3329
icon: "logos:oauth",
3430
title: "OAuth 2.0",
3531
description: "通过 OAuth 2.0 的方式登录系统",
36-
tags: ["MySQL", "PostgreSQL", "后端"],
37-
priceLabel: "免费"
32+
tags: ["mysql", "pgsql", "后端"]
3833
},
3934
{
4035
icon: "charm:shield-keyhole",
4136
title: "Casbin-RBAC",
4237
description: "基于 Casbin 实现的 RBAC 权限",
43-
tags: ["MySQL", "PostgreSQL", "后端"],
44-
link: "https://github.com/fastapi-practices/fba_casbin",
45-
image: "https://avatars.githubusercontent.com/u/27810343?s=200&v=4",
46-
priceLabel: "免费"
38+
tags: ["mysql", "pgsql", "后端"],
39+
link: "https://github.com/fastapi-practices/casbin_rbac",
40+
image: "https://avatars.githubusercontent.com/u/27810343?s=200&v=4"
4741
},
4842
{
49-
icon: "streamline:ai-prompt-spark",
50-
title: "MCP ChatGPT",
51-
description: "提供了 MCP 服务器管理功能，并支持调用 MCP 进行 AI 聊天",
52-
tags: ["MySQL", "PostgreSQL", "后端"],
53-
link: "https://github.com/fastapi-practices/fba_mcp",
54-
image: "https://github.com/modelcontextprotocol/.github/raw/main/profile/assets/light.png",
55-
priceLabel: "免费"
43+
icon: "codicon:mcp",
44+
title: "MCP 服务器管理",
45+
description: "提供了 MCP 服务器管理功能，并添加了可调用 MCP 的 AI 聊天接口",
46+
tags: ["mysql", "pgsql", "后端"],
47+
link: "https://github.com/fastapi-practices/mcp",
5648
},
5749
{
5850
icon: "ant-design:aliyun-outlined",
5951
title: "阿里云 oss",
6052
description: "阿里云 oss 文件上传",
61-
tags: ["MySQL", "PostgreSQL", "后端"],
62-
link: "https://github.com/fastapi-practices/fba_aliyun_oss",
63-
image: "https://img.alicdn.com/tfs/TB1Ly5oS3HqK1RjSZFPXXcwapXa-238-54.png",
64-
priceLabel: "免费"
53+
tags: ["mysql", "pgsql", "后端"],
54+
link: "https://github.com/fastapi-practices/aliyun_oss",
55+
image: "https://img.alicdn.com/tfs/TB1Ly5oS3HqK1RjSZFPXXcwapXa-238-54.png"
6556
},
6657
{
6758
icon: "material-symbols:token-outline",
6859
title: "配置下发",
6960
description: "将 env 等配置信息通过数据库进行管理",
70-
tags: ["MySQL", "后端", "前端"],
71-
link: "https://github.com/dividduang/option",
72-
priceLabel: "免费"
61+
tags: ["mysql", "后端", "前端"],
62+
link: "https://github.com/dividduang/option"
7363
},
7464
{
7565
icon: "ant-design:wechat-work-outlined",
7666
title: "企微 bot 定时任务",
7767
description: "定时调用企业微信群聊机器人发送消息",
78-
tags: ["MySQL", "后端"],
68+
tags: ["mysql", "后端"],
7969
link: "https://github.com/dividduang/wecom-task",
80-
image: "https://rescdn.qqmail.com/node/wework/images/Slice.d2258f37eb.png",
81-
priceLabel: "免费"
70+
image: "https://rescdn.qqmail.com/node/wework/images/Slice.d2258f37eb.png"
8271
},
8372
{
8473
icon: "arcticons:sso-plus",
8574
title: "Casdoor SSO",
8675
description: "通过 Casdoor 实现 SSO 单点登录集成",
87-
tags: ["MySQL", "PostgreSQL", "后端"],
76+
tags: ["mysql", "pgsql", "后端"],
8877
link: "/fastapi_best_architecture_docs/planet.html",
8978
image: "https://casdoor.org/zh/img/casdoor.png",
90-
priceLabel: "付费"
79+
free: false
9180
},
9281
{
9382
icon: "material-icon-theme:authors",
9483
title: "LDAP",
9584
description: "通过 LDAP 登录系统并授权",
96-
tags: ["MySQL", "PostgreSQL", "后端"],
97-
link: "https://github.com/dividduang/fba_plugin_ldap",
98-
image: "https://i0.wp.com/ldap.com/wp-content/uploads/2018/04/ldapdotcom-white-background-with-text-1024x341.png",
99-
priceLabel: "免费"
85+
tags: ["mysql", "pgsql", "后端"],
86+
link: "https://github.com/dividduang/ldap_auth",
87+
image: "https://www.cleo.com/sites/default/files/2023-12/ldap-integration.png"
10088
},
10189
]

‎docs/.vuepress/public/images/cursor.png

-4.08 KB
Binary file not shown.

‎docs/backend/ide/cursor.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ title: cursor
44

55
官网地址：[cursor](https://www.cursor.com/)
66

7-
## 规则
8-
97
我们在 cursor 中定做了一些规则，或许可以帮助您更好的使用 AI 生成代码
108

119
查看 cursor 官方文档：[rules-for-ai](https://docs.cursor.com/context/rules-for-ai)，然后添加以下规则
@@ -20,10 +18,6 @@ title: cursor
2018
此规则仅限用于 fba 项目
2119
:::
2220

23-
| 反馈 | 反应 |
24-
|:-----------------------------:|:--------------------------------------------------------:|
25-
![cursor](/images/cursor.png) | 我被调成啥了 <Icon name="openmoji:new-moon-face" size="2em" />
26-
2721
@[code mdc](../../code/fastapi.mdc)
2822

2923
### Python

‎docs/backend/reference/CORS.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,14 @@ CORS_ALLOWED_ORIGINS: list[str] = [
4444
CORS_ALLOWED_ORIGINS: list[str] = ['*']
4545
```
4646

47-
## 温馨提示
47+
## 注意事项
4848

49+
::: warning
4950
当将 `CORS_ALLOWED_ORIGINS` 配置为 `['*']` 时，socketio 将无法正常工作，这是由于它们的配置方式不同所导致的
5051

5152
这里有一个相关 PR: [python-engineio/pull/410](https://github.com/miguelgrinberg/python-engineio/pull/410)
5253

53-
如果此 PR 不被接受，请在 `backend/common/socketio/server.py` 文件中修改以下内容：
54+
虽然它已被合并，但是并没有发布新版本，截至目前，您需要在 `backend/common/socketio/server.py` 文件中修改以下内容：
5455

55-
`cors_allowed_origins=settings.CORS_ALLOWED_ORIGINS` -> `cors_allowed_origins='*'`
56+
`cors_allowed_origins=settings.CORS_ALLOWED_ORIGINS` -> `cors_allowed_origins='*'`
57+
:::

‎docs/backend/reference/limit.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ title: 节流
55
fba 内部使用 [fastapi-limit](https://github.com/fastapi-practices/fastapi_best_architecture/discussions/70)
66
实现后端接口节流
77

8-
使用方法如下：
9-
108
```python{1,6,11-17,25,29}
119
@app.get("/", dependencies=[Depends(RateLimiter(times=2, seconds=5))])
1210
async def index_get():

‎docs/backend/summary/fsm.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,12 @@
22
title: 精简版本
33
---
44

5-
::: warning
6-
FastAPI 最佳架构精简版的更新可能并不同步，你可能无法及时的在这些版本中获得新功能支持和问题修复
7-
:::
8-
9-
## SQLAlchemy
5+
FastAPI 最佳架构精简版的目标是仅保留最最最简单得架构
106

117
<RepoCard repo="fastapi-practices/fastapi_sqlalchemy_mysql" />
128

13-
## Tortoise-ORM
9+
<RepoCard repo="fastapi-practices/fastapi_tortoise_mysql" />
1410

15-
<RepoCard repo="fastapi-practices/fastapi_tortoise_mysql" />
11+
::: warning
12+
精简版的更新速度并不同步，我们目前正在积极寻找维护人员
13+
:::

0 commit comments

Comments
 (0)