WDC SaaS Starter Kit 使用指南

WDC SaaS Starter Kit 使用指南

wdc-saas-starter-kit 项目地址: https://gitcode.com/gh_mirrors/wd/wdc-saas-starter-kit

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

该项目是基于 Next.js 的 SaaS 应用的起始模板，包含了以下目录和文件结构：

wdc-saas-starter-kit/
├── .dockerignore
├── .env.sample
├── .eslintrc.js
├── .gitignore
├── components.json
├── docker-compose.yml
├── drizzle.config.ts
├── mdx-components.tsx
├── next.config.mjs
├── package-lock.json
├── package.json
├── postcss.config.mjs
├── README.md
├── run.sh
├── source.config.ts
├── tailwind.config.ts
├── tsconfig.json
├── public/
│   └── ...
├── src/
│   └── ...
└── ...

• public/: 存放公共静态文件，如图标、图片等。
• src/: 源代码目录，包含所有应用的业务逻辑和组件。
• .dockerignore: 指定 Docker 构建时应忽略的文件和目录。
• .env.sample: 环境变量示例文件，用于本地开发。
• .eslintrc.js: ESLint 配置文件，用于代码质量和风格检查。
• .gitignore: 指定 Git 应忽略的文件和目录。
• components.json: 组件配置文件。
• docker-compose.yml: Docker Compose 配置文件，用于定义和运行多容器 Docker 应用。
• drizzle.config.ts: Drizzle ORM 配置文件。
• mdx-components.tsx: MDX 组件文件。
• next.config.mjs: Next.js 配置文件。
• package-lock.json: npm 依赖锁文件。
• package.json: 项目包文件，定义项目依赖和脚本。
• postcss.config.mjs: PostCSS 配置文件。
• README.md: 项目说明文件。
• run.sh: 运行脚本。
• source.config.ts: 源配置文件。
• tailwind.config.ts: Tailwind CSS 配置文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动主要通过 package.json 中的脚本进行。

• npm run dev: 启动本地开发服务器，通常监听在 http://localhost:3000。
• npm run db:migrate: 运行数据库迁移脚本，用于初始化数据库结构。
• docker compose up: 使用 Docker Compose 启动应用，包括数据库等所有服务。

3. 项目的配置文件介绍

项目的配置文件包括环境变量配置、Docker 配置、ORM 配置等。

• .env.sample: 本地开发环境变量配置示例，包括数据库连接、API 密钥等。
• docker-compose.yml: 定义了项目中使用到的服务，如数据库、应用服务器等。
• drizzle.config.ts: 配置 Drizzle ORM，用于数据库操作。
• next.config.mjs: Next.js 的配置文件，可以定义自定义路由、环境变量等。
• tailwind.config.ts: Tailwind CSS 的配置文件，用于定制化样式。

在开始项目之前，需要将 .env.sample 文件复制为 .env 文件，并填入实际的环境变量值。

wdc-saas-starter-kit 项目地址: https://gitcode.com/gh_mirrors/wd/wdc-saas-starter-kit