For AI agents: the complete documentation index is available at https://liangy0323.github.io/ly-fullstack/llms.txt, the full documentation bundle is available at https://liangy0323.github.io/ly-fullstack/llms-full.txt, and this page is available as Markdown at https://liangy0323.github.io/ly-fullstack/guide/index.md.

认识 LY Fullstack

LY Fullstack 是一套面向个人开发者、小型团队和中小型真实项目的全栈工程底座。它解决的是“每个项目都要重复搭建的通用部分”,而不是替你预设某个具体 C 端产品。

你会直接获得什么

仓库已经完成三条可运行链路:

  1. 管理后台:Vue 3、Rsbuild、Element Plus、Pinia、Vue Router,包含登录、动态菜单、双主题、CRUD 页面和异常页。
  2. 管理 API:NestJS + Fastify,包含账号密码登录、一次性图片滑块验证、JWT 会话、五表 RBAC 与系统管理接口。
  3. 默认 C 端 API:独立 NestJS 应用,提供健康检查、公共字典和非敏感公共配置读取,并作为后续业务模块的编码基线。

数据库、共享类型、图表能力和工程脚本位于 packages/scripts/。所有应用都可以独立启动和部署,但当前架构仍是模块化单体,不包含微服务治理设施。

它为什么不提供默认 C 端页面

C 端可能是小程序、官网、后台之外的 SPA、移动端或某个垂直产品。提前选择 Vue、React、Nuxt、Next.js 或小程序中的任意一种,都会把并不通用的产品假设写进底座。

因此,默认 apps/api 只提供大量 C 端业务都会用到的公共读取能力,并展示模块、配置、数据库、测试和错误处理应该怎样组织。你需要根据真实产品形态选择客户端,再在 apps/api 中增加业务;只有独立部署或故障隔离确实成为需求时,才创建额外服务。

适合哪些项目

  • 企业网站、小程序、内容平台和功能型 Web 产品的管理端与业务 API。
  • 个人产品、MVP、初创项目和小型团队协作项目。
  • 运营后台、内部管理系统,以及需要真实权限闭环的中小型业务。
  • 希望用一套明确规则约束人和 AI 协作的 TypeScript 项目。

哪些情况不能直接套用

  • 已经明确需要服务发现、分布式事务、跨地域容灾或复杂多租户隔离。
  • 终端用户认证、支付、订单、消息等领域规则尚未设计,却希望模板直接给出业务答案。
  • 只想复制页面,不愿维护数据库 migration、权限码、接口契约和质量门禁。

这些场景并不意味着项目永远不能演进,而是需要先完成额外设计,不能把尚未实现的能力当作默认保障。

推荐阅读顺序

  1. 快速开始:完成安装、数据库初始化和第一次登录。
  2. 目录与职责:知道功能应该放在哪里。
  3. 项目边界:避免应用反向依赖或认证边界混用。
  4. 开发第一个业务:按可验证的顺序落地功能。
  5. 管理后台服务端:进入对应技术栈的具体流程。
不需要一次读完

第一次运行只需要完成快速开始。准备修改某一层时,再进入对应专题;每个页面都给出了继续阅读和验证命令。