Fest 项目使用教程

Fest 项目使用教程

fest SaaS boilerplate built with Node.js & React. 项目地址: https://gitcode.com/gh_mirrors/fe/fest

1. 项目的目录结构及介绍

Fest 项目是一个基于 Node.js 和 React 的 SaaS 样板项目，采用 Monorepo 结构。以下是项目的目录结构及其介绍：

fest/
├── apps/
│   ├── api/          # Nest.js 应用程序
│   └── frontend/     # Next.js 应用程序
├── libs/
│   └── shared/       # 共享库，包含 Typescript 类型、常量和工具函数
├── tools/            # 项目工具
├── docs/             # 项目文档
├── .editorconfig     # 编辑器配置文件
├── .eslintrc.json    # ESLint 配置文件
├── .gitignore        # Git 忽略文件配置
├── .prettierignore   # Prettier 忽略文件配置
├── .prettierrc       # Prettier 配置文件
├── CODE_OF_CONDUCT.md # 行为准则
├── LICENSE           # 项目许可证
├── README.md         # 项目说明文件
├── babel.config.json # Babel 配置文件
├── jest.config.ts    # Jest 配置文件
├── migrations.json   # 数据库迁移配置
├── nx.json           # Nx 配置文件
├── package.json      # 项目依赖配置
├── screenshot.png    # 项目截图
├── screenshot2.png   # 项目截图
├── tsconfig.base.json # TypeScript 基础配置
├── workspace.json    # 工作区配置
└── yarn.lock         # Yarn 锁定文件

目录结构说明

• apps/: 包含两个主要应用程序：api 和 frontend。
  • api/: 使用 Nest.js 构建的后端应用程序。
  • frontend/: 使用 Next.js 构建的前端应用程序。
• libs/shared/: 共享库，用于在 api 和 frontend 之间共享 Typescript 类型、常量和工具函数。
• tools/: 项目工具目录。
• docs/: 项目文档目录。
• 配置文件: 包含各种配置文件，如 .editorconfig, .eslintrc.json, .gitignore, .prettierignore, .prettierrc, babel.config.json, jest.config.ts, migrations.json, nx.json, package.json, tsconfig.base.json, workspace.json, yarn.lock 等。

2. 项目的启动文件介绍

Fest 项目的启动文件主要位于 apps/ 目录下，分别用于启动后端和前端应用程序。

后端启动文件

• apps/api/src/main.ts: 这是 Nest.js 应用程序的入口文件，负责启动后端服务。

前端启动文件

• apps/frontend/src/pages/_app.tsx: 这是 Next.js 应用程序的入口文件，负责初始化前端应用。

3. 项目的配置文件介绍

Fest 项目的配置文件主要用于定义项目的各种设置，包括开发环境、测试环境、构建配置等。

主要配置文件

• .editorconfig: 定义编辑器的配置，确保代码风格一致。
• .eslintrc.json: ESLint 配置文件，用于代码检查和格式化。
• .gitignore: Git 忽略文件配置，指定哪些文件或目录不需要被 Git 管理。
• .prettierignore: Prettier 忽略文件配置，指定哪些文件或目录不需要被 Prettier 格式化。
• .prettierrc: Prettier 配置文件，用于代码格式化。
• babel.config.json: Babel 配置文件，用于转换 JavaScript 代码。
• jest.config.ts: Jest 配置文件，用于单元测试。
• migrations.json: 数据库迁移配置文件。
• nx.json: Nx 配置文件，用于 Monorepo 管理。
• package.json: 项目依赖配置文件，定义项目的依赖包和脚本。
• tsconfig.base.json: TypeScript 基础配置文件。
• workspace.json: 工作区配置文件，定义工作区的结构和配置。
• yarn.lock: Yarn 锁定文件，确保依赖包版本一致。

通过以上配置文件，Fest 项目能够灵活地适应不同的开发环境和需求。

fest SaaS boilerplate built with Node.js & React. 项目地址: https://gitcode.com/gh_mirrors/fe/fest