SuperMemory 项目教程

SuperMemory 项目教程

supermemory Build your own second brain with supermemory. It's a ChatGPT for your bookmarks. Import tweets or save websites and content using the chrome extension. 项目地址: https://gitcode.com/gh_mirrors/su/supermemory

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

SuperMemory 项目的目录结构如下：

supermemory/
├── apps/
│   ├── web/
│   ├── extension/
│   └── cf-ai-backend/
├── packages/
├── .eslintrc.js
├── .gitattributes
├── .gitignore
├── .gitmodules
├── .npmrc
├── .prettierignore
├── .prettierrc
├── LICENSE
├── README.md
├── SETUP-GUIDE.md
├── components.json
├── package.json
├── pnpm-lock.yaml
├── pnpm-workspace.yaml
├── tsconfig.json
└── turbo.json

目录结构介绍

• apps/: 包含项目的三个主要模块：

  • web/: 主 Web UI，数据库和认证逻辑所在。
  • extension/: Chrome 扩展，用于轻松添加页面到记忆库。
  • cf-ai-backend/: 处理向量存储和 AI 响应生成的模块。

• packages/: 包含项目使用的各种包。

• .eslintrc.js: ESLint 配置文件。

• .gitattributes: Git 属性配置文件。

• .gitignore: Git 忽略文件配置。

• .gitmodules: Git 子模块配置文件。

• .npmrc: npm 配置文件。

• .prettierignore: Prettier 忽略文件配置。

• .prettierrc: Prettier 配置文件。

• LICENSE: 项目许可证文件。

• README.md: 项目介绍和使用说明。

• SETUP-GUIDE.md: 项目设置指南。

• components.json: 组件配置文件。

• package.json: npm 包配置文件。

• pnpm-lock.yaml: pnpm 锁定文件。

• pnpm-workspace.yaml: pnpm 工作区配置文件。

• tsconfig.json: TypeScript 配置文件。

• turbo.json: Turborepo 配置文件。

2. 项目的启动文件介绍

SuperMemory 项目的启动文件主要位于 apps/web/ 目录下。以下是主要的启动文件：

• apps/web/pages/_app.tsx: 这是 Next.js 项目的入口文件，用于初始化应用的全局状态和布局。
• apps/web/pages/index.tsx: 这是主页面的入口文件，包含了应用的主要逻辑和 UI 组件。
• apps/web/pages/api/: 包含 API 路由文件，用于处理后端逻辑。

3. 项目的配置文件介绍

SuperMemory 项目的配置文件主要用于配置项目的各种环境和工具。以下是主要的配置文件：

• .eslintrc.js: 配置 ESLint，用于代码风格检查和错误检测。
• .prettierrc: 配置 Prettier，用于代码格式化。
• tsconfig.json: 配置 TypeScript，用于编译和类型检查。
• turbo.json: 配置 Turborepo，用于管理多包项目。
• pnpm-workspace.yaml: 配置 pnpm 工作区，用于管理多个包的依赖关系。

这些配置文件确保了项目的代码质量和开发环境的统一性。

supermemory Build your own second brain with supermemory. It's a ChatGPT for your bookmarks. Import tweets or save websites and content using the chrome extension. 项目地址: https://gitcode.com/gh_mirrors/su/supermemory