ottomon

Ottomon：使用代码、视频和文档聊天

Ottomon 是一个强大的 GenAI 平台，使您能够轻松地将任何网站、YouTube 频道或 GitHub 存储库转变为动态聊天机器人。无论您是想提高用户参与度、简化支持，还是只是探索新的可能性，Ottomon 都能满足您的需求。

入门

要开始使用 Ottomon，请按照以下简单步骤操作：

1. 克隆存储库：首先将 Ottomon 存储库克隆到本地环境。

   git clone https://github.com/vgulerianb/ottomon.git

2. 配置：创建.env文件来配置您的 Ottomon 实例。该文件应包含以下变量：

   • OPENAI_API_KEY ：您的 OpenAI API 密钥。
   • NEXT_PUBLIC_SUPABASE_URL ：Supabase 实例的 URL（为此目的在 Supabase 上创建一个新项目）。
   • SUPABASE_SERVICE_ROLE_KEY ：Supabase 实例的服务角色密钥（为此目的在 Supabase 上创建一个新项目）。
   • JWT_SECRET ：用于签署 JWT 令牌的密钥。
   • SQL_CONNECTION_STRING ：Supabase 数据库的连接字符串（为此在 Supabase 上创建一个新项目）。

3. 初始化数据库：运行以下命令来初始化数据库并在 Supabase 实例中设置必要的表和数据。

   npx prisma db push

4. 运行奥托蒙：

   • 使用 Docker：

     • 构建 Docker 镜像：

       docker build -t ottomon .

     • 运行 Docker 容器：

       docker run -p 3000:3000 ottomon

   • 从本地开始：

     • 安装依赖项：

       yarn install

     • 构建应用程序：

       yarn build

     • 启动 Ottomon Web 应用程序：

       yarn start

贡献

我们欢迎为 Ottomon 做出贡献！如果您想做出贡献，请按照以下步骤操作：

1. 分叉存储库：首先将 Ottomon 存储库分叉到您的 GitHub 帐户。

2. 创建新分支：为您的功能或错误修复创建新分支（例如feature/my-new-feature ）。

3. 做出您的更改：在分支机构内实施您的更改。

4. 提交您的更改：使用描述性消息（例如“添加一些功能”）提交您的更改。

5. 推送到分支：将更改推送到 GitHub 上的分支。

6. 创建拉取请求：创建一个新的拉取请求以提出您的更改以供审核并包含在 Ottomon 项目中。

Ottomon 是一个令人兴奋的 GenAI 平台，您的贡献可以帮助使它变得更好！

---

请根据您的 Ottomon 项目的需要随意调整和修改此自述文件。