开源项目 create-t3-turbo
使用教程
1. 项目目录结构及介绍
create-t3-turbo
是一个基于 T3 Stack 和 Expo React Native 的 Monorepo 项目模板。以下是项目的目录结构及其介绍:
create-t3-turbo/
├── apps/
│ ├── expo/
│ │ ├── src/
│ │ ├── App.tsx
│ │ ├── app.json
│ │ └── package.json
│ └── nextjs/
│ ├── pages/
│ ├── public/
│ ├── styles/
│ ├── next.config.js
│ └── package.json
├── packages/
│ ├── api/
│ │ ├── src/
│ │ ├── package.json
│ │ └── tsconfig.json
│ ├── auth/
│ │ ├── src/
│ │ ├── package.json
│ │ └── tsconfig.json
│ └── db/
│ ├── prisma/
│ ├── src/
│ ├── package.json
│ └── tsconfig.json
├── .env.example
├── .gitignore
├── package.json
├── pnpm-lock.yaml
├── pnpm-workspace.yaml
├── README.md
└── turbo.json
目录结构说明
-
apps/: 包含主要的应用程序目录。
- expo/: Expo 应用程序的根目录,包含 React Native 代码和配置文件。
- nextjs/: Next.js 应用程序的根目录,包含 Next.js 代码和配置文件。
-
packages/: 包含共享的包和库。
- api/: 包含 tRPC v10 路由定义。
- auth/: 包含使用 next-auth 进行身份验证的代码。
- db/: 包含使用 Prisma 进行数据库操作的代码。
-
.env.example: 环境变量示例文件。
-
.gitignore: Git 忽略文件配置。
-
package.json: 项目的根
package.json
文件。 -
pnpm-lock.yaml: pnpm 锁文件。
-
pnpm-workspace.yaml: pnpm 工作区配置文件。
-
README.md: 项目说明文档。
-
turbo.json: Turborepo 配置文件。
2. 项目的启动文件介绍
Expo 应用程序启动文件
- apps/expo/App.tsx: Expo 应用程序的入口文件,包含 React Native 组件和导航配置。
- apps/expo/app.json: Expo 应用程序的配置文件,包含应用程序的元数据和配置选项。
Next.js 应用程序启动文件
- apps/nextjs/pages/index.tsx: Next.js 应用程序的首页文件,包含 React 组件和页面逻辑。
- apps/nextjs/next.config.js: Next.js 应用程序的配置文件,包含构建和运行时的配置选项。
3. 项目的配置文件介绍
环境变量配置
- .env.example: 环境变量示例文件,包含项目所需的环境变量及其示例值。
包管理器配置
- package.json: 项目的根
package.json
文件,包含项目的依赖和脚本命令。 - pnpm-lock.yaml: pnpm 锁文件,确保依赖版本的一致性。
- pnpm-workspace.yaml: pnpm 工作区配置文件,定义了 Monorepo 的工作区结构。
Turborepo 配置
- turbo.json: Turborepo 配置文件,包含构建和缓存的配置选项。
其他配置文件
- .gitignore: Git 忽略文件配置,指定哪些文件和目录不应被 Git 跟踪。
- README.md: 项目说明文档,包含项目的介绍、安装和使用说明。
通过以上介绍,您可以更好地理解和使用 create-t3-turbo
项目模板。