Zero-Calendar 项目启动与配置教程

1. 项目目录结构及介绍

Zero-Calendar 项目是一个开源的 AI 日历解决方案，项目目录结构如下：

zero-calendar/
├── .github/              # GitHub 相关配置文件
├── app/                  # 应用程序主要代码目录
│   ├── components/       # 通用组件
│   ├── hooks/            # 自定义钩子
│   ├── lib/              # 工具库和辅助函数
│   ├── public/           # 公共静态文件
│   ├── styles/           # 样式文件
│   ├── types/            # TypeScript 类型定义
│   ├── middleware.ts     # 中间件配置
│   ├── next.config.mjs   # Next.js 配置
│   ├── package.json      # 项目依赖和配置
│   ├── package-lock.json # 依赖锁文件
│   ├── pnpm-lock.yaml     # pnpm 锁文件
│   ├── postcss.config.mjs # PostCSS 配置
│   └── tailwind.config.ts # TailwindCSS 配置
├── .gitignore            # 忽略文件配置
├── LICENSE.md            # 开源许可证
├── README.md             # 项目说明文件
├── components.json       # 组件配置
└── environment variables # 环境变量配置

2. 项目的启动文件介绍

项目的启动主要通过以下文件进行：

• next.config.mjs: Next.js 的配置文件，用于设置项目的运行参数，例如端口、环境变量等。

• package.json: 包含项目的依赖项和启动脚本。以下是启动开发的命令：

  npm run dev
  

  或

  pnpm dev
  

  运行上述命令后，Next.js 开发服务器将在 http://localhost:3000 上启动。

3. 项目的配置文件介绍

项目的主要配置文件如下：

• .env.example: 环境变量示例文件，展示了项目中需要配置的环境变量及其默认值。
• .env.local: 本地环境变量文件，用于本地开发时配置环境变量。此文件不应提交到版本控制系统中。

以下是一些必须配置的环境变量：

• NEXTAUTH_SECRET: NextAuth 的密钥，用于加密认证信息。
• NEXTAUTH_URL: 应用的 URL。
• GOOGLE_CLIENT_ID 和 GOOGLE_CLIENT_SECRET: Google OAuth 集成所需的客户端 ID 和密钥。
• KV_URL, KV_REST_API_URL, KV_REST_API_TOKEN, KV_REST_API_READ_ONLY_TOKEN: Vercel KV（Redis）的配置。
• GROQ_API_KEY: AI 功能所需的 API 密钥。

在开始之前，需要将 .env.example 文件复制为 .env.local 并填入相应的配置信息。

以上就是 Zero-Calendar 项目的目录结构、启动文件和配置文件的介绍。通过这些信息，您可以开始搭建和配置项目。