Skip to content

Read in English

快速入门

几分钟内启动 FSD 架构项目

FSD CLI 是一个命令行工具,可创建具有完整 Feature-Sliced Design 结构的 React、Next.js、Vue、Nuxt 或 SvelteKit 项目,并随着项目增 长生成切片(features、entities、widgets、pages)。其余文档目前仅 提供英文版。

要求

需要 Node.js 22.12.0 或更高版本。Nuxt 和 SvelteKit 项目需要 22.22.2 或更高版本。请检查已安装的版本:

bash
node --version

创建项目

在希望创建项目的目录中运行该命令,然后在交互式向导中选择框架、 状态管理工具和模板:

bash
npx create-fsd-architecture@latest my-app

或直接接受默认设置,同时指定框架:

bash
npx create-fsd-architecture@latest my-app --framework react-vite --yes

生成切片

在项目根目录下,生成器会读取文件 fsd.config.json 并为你的框架创建文件。使用 --dry-run 可以先预览文件:

bash
npx create-fsd-architecture@latest -g entity product --dry-run
npx create-fsd-architecture@latest -g feature cart
npx create-fsd-architecture@latest -g widget navbar
npx create-fsd-architecture@latest -g page catalog

每个切片都会获得一个 index.ts 文件——它的公共 API,其他层只能通过它从切片导入。

安全升级

安装更新版本的工具不会自动更改你的项目。请先查看升级计划,确认其 中没有冲突后再应用:

bash
npx create-fsd-architecture@latest upgrade --dry-run
npx create-fsd-architecture@latest upgrade --yes

下一步

Support FSD CLI

If FSD CLI helps you build, consider supporting its development and documentation. Donations are optional.

GitHub Sponsors (opens in a new tab)Buy Me a Coffee (opens in a new tab)

InstaPay · Egypt

ashrafmo-1

للدعم من مصر عبر إنستا باي. تأكد من بيانات المستلم قبل تأكيد التحويل.