开源项目启动和配置教程

开源项目启动和配置教程

presentation-ai Open source AI presentation generator. Create professional slides with customizable themes and AI-generated content in minutes. 项目地址: https://gitcode.com/gh_mirrors/pr/presentation-ai

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

本项目是基于GitHub开源的AI演讲稿生成器，其目录结构如下：

presentation/
├── .next/               # Next.js 构建输出
├── node_modules/        # 项目依赖
├── prisma/              # 数据库模式
│   └── schema.prisma    # Prisma 数据库模型
├── src/                 # 源代码
│   ├── app/             # Next.js 应用路由
│   ├── components/      # 可复用UI组件
│   │   ├── auth/        # 认证组件
│   │   ├── presentation/ # 演讲稿相关组件
│   │   │   ├── dashboard/   # 仪表盘UI
│   │   │   ├── editor/      # 演讲稿编辑器
│   │   │   │   ├── custom-elements/ # 自定义编辑器元素
│   │   │   │   ├── dnd/              # 拖放功能
│   │   │   │   └── native-elements/ # 本地编辑器元素
│   │   │   ├── outline/     # 演讲稿大纲组件
│   │   │   ├── theme/       # 主题相关组件
│   │   │   └── utils/       # 演讲稿工具
│   │   ├── prose-mirror/  # ProseMirror 编辑器组件
│   │   ├── text-editor/   # 文本编辑器组件
│   │   │   ├── hooks/       # 编辑器钩子
│   │   │   ├── lib/         # 编辑器库
│   │   │   ├── plate-ui/    # Plate 编辑器UI组件
│   │   │   └── plugins/     # 编辑器插件
│   │   └── ui/           # 共享UI组件
│   ├── hooks/           # 自定义React钩子
│   ├── lib/             # 实用函数和共享代码
│   ├── provider/        # 上下文提供者
│   ├── server/          # 服务器端代码
│   ├── states/          # 状态管理
│   ├── middleware.ts    # Next.js中间件
│   └── env.js           # 环境配置
├── .env                 # 环境变量
├── .env.example         # 示例环境变量
├── next.config.js       # Next.js配置
├── package.json         # 项目依赖和脚本
├── tailwind.config.ts   # Tailwind CSS配置
└── tsconfig.json        # TypeScript配置

2. 项目的启动文件介绍

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

• pnpm dev: 使用 pnpm 包管理器启动开发服务器。pnpm 是一种更高效的包管理工具，能够以更少的磁盘空间和更快的速度安装依赖。
• next.config.js: Next.js 的配置文件，用于自定义Web应用的构建和运行时行为。
• package.json: 定义了项目的依赖、脚本和元数据。

启动项目时，在项目根目录下执行以下命令：

pnpm install # 安装依赖
pnpm dev      # 启动开发服务器

启动后，在浏览器中访问 http://localhost:3000 可以查看应用。

3. 项目的配置文件介绍

项目的配置文件主要包括：

• .env.example: 提供了所有需要配置的环境变量的示例。
• .env: 真正的环境变量文件，其中包含了应用运行时所需的各种API密钥和配置信息。

以下是一些需要配置的环境变量：

• OPENAI_API_KEY: OpenAI API密钥，用于AI内容生成。
• TOGETHER_AI_API_KEY: Together AI API密钥，用于图片生成。
• NEXTAUTH_SECRET: NextAuth.js的密钥，用于用户认证。
• GOOGLE_CLIENT_ID 和 GOOGLE_CLIENT_SECRET: Google认证所需的客户端ID和密钥。

根据.env.example文件创建.env文件，并填入相应的值。

以上就是项目的目录结构、启动文件以及配置文件的介绍。通过这些信息，你可以开始搭建和运行这个开源项目。

presentation-ai Open source AI presentation generator. Create professional slides with customizable themes and AI-generated content in minutes. 项目地址: https://gitcode.com/gh_mirrors/pr/presentation-ai