Adeus 开源项目教程

Adeus 开源项目教程

ADeus An open source AI wearable device that captures what you say and hear in the real world and then transcribes and stores it on your own server. You can then chat with Adeus using the app, and it will have all the right context about what you want to talk about - a truly personalized, personal AI. 项目地址: https://gitcode.com/gh_mirrors/ad/ADeus

1. 项目目录结构及介绍

Adeus 项目目录结构如下：

ADeus/
├── .github/             # GitHub 工作流目录
│   └── workflows/
├── app/                 # 移动/网页应用源代码
├── devices/            # 硬件设备相关代码和文档
├── docs/               # 项目文档
├── scripts/            # 脚本文件
├── supabase/           # 后端和数据库相关代码
├── .gitignore          # Git 忽略文件
├── .gitmodules         # Git 子模块配置文件
├── .prettierignore     # Prettier 忽略文件
├── LICENSE             # 项目许可证文件
├── README.md           # 项目说明文件
├── TODO.md             # 项目待办事项列表
└── prettier.config.cjs # Prettier 配置文件

介绍

• .github/: 存放 GitHub Actions 工作流文件，用于自动化项目流程。
• app/: 包含移动或网页应用的前端源代码。
• devices/: 包含与硬件设备相关的代码和文档。
• docs/: 包含项目文档，包括使用和安装指南。
• scripts/: 包含项目相关的脚本文件。
• supabase/: 包含后端和数据库的代码。
• .gitignore: 指定 Git 应该忽略的文件和目录。
• .gitmodules: 用于配置 Git 子模块。
• .prettierignore: 指定 Prettier 应该忽略的文件。
• LICENSE: 项目使用的许可证信息。
• README.md: 项目的基本介绍和说明。
• TODO.md: 记录项目的待办事项和未来计划。
• prettier.config.cjs: Prettier 的配置文件。

2. 项目的启动文件介绍

项目的启动文件通常位于 app/ 目录下，具体的启动文件会根据项目的具体技术栈而有所不同。例如，如果使用 Node.js 作为后端服务器，启动文件可能是 app/index.js。以下是启动文件的简单示例：

// app/index.js

const express = require('express');
const app = express();

app.get('/', (req, res) => {
  res.send('Adeus 服务器运行中...');
});

const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`服务器运行在 http://localhost:${PORT}`);
});

这个文件创建了一个简单的 Express 服务器，当访问根路径时会返回一个简单的消息。

3. 项目的配置文件介绍

配置文件通常包含项目运行所需的设置和参数。在 ADeus 项目中，配置文件可能位于 supabase/ 目录下，例如 config.json。

// supabase/config.json

{
  "databaseUrl": "https://your-supabase-url.supabase.co",
  "supabaseKey": "your-supabase-anon-key"
}

在这个配置文件中，我们定义了 Supabase 数据库的 URL 和匿名访问密钥。这些信息是项目运行时连接到数据库所必需的。在实际使用中，敏感信息如密钥应该通过环境变量来管理，而不是直接硬编码在配置文件中。

ADeus An open source AI wearable device that captures what you say and hear in the real world and then transcribes and stores it on your own server. You can then chat with Adeus using the app, and it will have all the right context about what you want to talk about - a truly personalized, personal AI. 项目地址: https://gitcode.com/gh_mirrors/ad/ADeus