Titan 项目启动与配置教程

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

Titan 是一个基于 Next.js 15 的全栈项目模板，它使用了 better-auth 进行认证，drizzle-orm 作为 ORM。以下是项目的目录结构及其介绍：

 titan/
 ├── drizzle/           # 包含 drizzle-orm 相关的迁移文件
 │   └── migrations/
 ├── public/            # 公共静态文件目录
 ├── src/              # 源代码目录
 │   ├── .env.example  # 环境变量示例文件
 │   ├── .gitignore    # Git 忽略文件
 │   ├── LICENSE.md    # 开源协议文件
 │   ├── README.md     # 项目说明文件
 │   ├── bun.lock      # bun 包管理器的锁定文件
 │   ├── components.json # 组件配置文件
 │   ├── docker-compose.yml # Docker 配置文件
 │   ├── drizzle.config.ts # drizzle-orm 配置文件
 │   ├── next.config.ts   # Next.js 配置文件
 │   ├── package.json    # 项目依赖和脚本
 │   ├── postcss.config.mjs # PostCSS 配置文件
 │   ├── tsconfig.json   # TypeScript 配置文件
 │   └── ...             # 其他源代码文件
 └── ...                # 其他项目文件

• drizzle/：包含数据库迁移文件。
• public/：存放公共静态文件，如图片、CSS、JavaScript 文件等。
• src/：项目的主要目录，包括所有源代码和配置文件。

2. 项目的启动文件介绍

项目的启动主要是通过 package.json 中的脚本进行的。以下是一些关键的启动脚本：

• bun install：安装项目依赖。
• bun run db:generate：生成数据库架构。
• bun run db:migrate：迁移数据库。
• bun dev：启动开发服务器。

这些脚本在 package.json 文件中定义，如下所示：

{
  "scripts": {
    "install": "bun install",
    "db:generate": "bun run db:generate",
    "db:migrate": "bun run db:migrate",
    "dev": "bun dev"
  }
}

3. 项目的配置文件介绍

项目的配置主要通过以下几个文件来完成：

• .env.example：环境变量示例文件，用于展示如何设置项目环境变量。
• drizzle.config.ts：drizzle-orm 的配置文件，用于配置数据库连接和其他 ORM 相关设置。
• next.config.ts：Next.js 的配置文件，用于自定义 Next.js 的行为。
• postcss.config.mjs：PostCSS 的配置文件，用于定义 CSS 的转换和优化。

例如，drizzle.config.ts 可能包含以下内容：

import { drizzle } from 'drizzle-orm';
import { pgDatabase } from 'drizzle-orm/databases/pg';

export default drizzle({
  database: pgDatabase({
    connection: process.env.DATABASE_URL,
  }),
  // 其他 drizzle 配置...
});

这个文件配置了 drizzle-orm 使用 PostgreSQL 数据库的连接。

确保在开始项目之前，你已经创建了 .env 文件，并根据 .env.example 文件中的说明设置了所有必要的环境变量。这将确保项目能够正确地访问数据库和其他配置项。