《Midday AI v1 开源项目安装与配置指南》

《Midday AI v1 开源项目安装与配置指南》

v1 An open-source starter kit based on Midday. 项目地址: https://gitcode.com/gh_mirrors/v11/v1

1. 项目基础介绍

本项目是基于 Midday 的一个开源启动套件（Starter Kit），它提供了一个预配置的代码库，旨在帮助开发者快速搭建生产就绪的 SaaS 应用程序。该套件采用了最新的 Next.js 框架，并以代码复用和最佳实践为核心，随着你的业务增长而扩展。

主要编程语言：

• TypeScript：为 JavaScript 提供类型安全。

2. 关键技术和框架

项目中使用的关键技术和框架包括但不限于以下内容：

• Next.js：用于构建服务端渲染的 React 应用程序。
• Turborepo：用于管理单代码库（monorepo）的构建系统。
• Biome：作为代码的格式化工具和静态分析器。
• TailwindCSS：用于快速UI设计的实用程序优先的CSS框架。
• Shadcn：提供了一系列的 UI 组件。
• Supabase：一体化的后端服务，提供认证、数据库、存储等功能。
• Upstash：用于缓存和速率限制。
• React Email：构建电子邮件模板。
• Resend：用于电子邮件发送服务。
• i18n：国际化和本地化支持。
• Sentry：用于错误处理和监控。
• Dub：用于创建可共享的链接。
• Trigger.dev：用于后台任务。
• OpenPanel：提供分析服务。
• Polar：计费服务（即将推出）。
• next-themes：主题管理器。

3. 安装和配置准备工作

在开始安装之前，请确保你的开发环境中已经安装了以下工具：

• Bun：一个快速、全功能的 JavaScript 运行时。
• Docker：容器化平台，用于运行应用程序。
• Upstash、Dub、Trigger.dev、Resend、Supabase、Sentry、OpenPanel：这些是本项目依赖的外部服务，你可能需要注册并创建相应的账户以获取API密钥。

4. 安装步骤

以下是将该开源项目安装到本地开发环境的详细步骤：

1. 克隆项目到本地：

   bunx degit midday-ai/v1 v1
   

2. 进入项目目录并安装依赖：

   cd v1
   bun i
   

3. 复制 .env.example 文件到 .env，并根据需要更新环境变量。对于每个应用（api、app、web），都需要进行以下操作：

   cp apps/api/.env.example apps/api/.env
   cp apps/app/.env.example apps/app/.env
   cp apps/web/.env.example apps/web/.env
   

4. 启动开发服务器，可以启动全部服务或者选择启动特定的服务：

   • 启动全部服务：

     bun dev
     

   • 只启动 Web 应用：

     bun dev:web
     

   • 只启动 App 应用：

     bun dev:app
     

   • 只启动 API 服务：

     bun dev:api
     

   • 只启动 Email 服务：

     bun dev:email
     

5. 运行数据库迁移和种子数据填充（如果需要的话）：

   bun migrate
   bun seed
   

按照以上步骤操作后，你的开发环境应该已经配置完毕，可以开始开发你的应用程序了。本项目提供了丰富的代码示例和最佳实践，可以帮助你快速上手。

v1 An open-source starter kit based on Midday. 项目地址: https://gitcode.com/gh_mirrors/v11/v1