Learning-By-GPT 项目使用教程

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

Learning-By-GPT/
├── README.md
├── chrome-extension/
│   ├── background.js
│   ├── content.js
│   ├── manifest.json
│   ├── popup.html
│   └── popup.js
├── docs/
│   └── tutorial.md
└── src/
    ├── ai.js
    ├── index.js
    └── utils.js

• README.md: 项目介绍文件。
• chrome-extension/: Chrome 扩展相关文件。
  • background.js: 后台脚本。
  • content.js: 内容脚本。
  • manifest.json: 扩展的配置文件。
  • popup.html: 弹出窗口的 HTML 文件。
  • popup.js: 弹出窗口的脚本文件。
• docs/: 文档目录。
  • tutorial.md: 使用教程文档。
• src/: 源代码目录。
  • ai.js: AI 相关逻辑。
  • index.js: 主入口文件。
  • utils.js: 工具函数。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js。该文件包含了项目的初始化逻辑和主要功能入口。

// src/index.js
import { initAI } from './ai.js';
import { setupUtils } from './utils.js';

async function main() {
    await initAI();
    setupUtils();
    // 其他初始化逻辑
}

main();

3. 项目的配置文件介绍

项目的配置文件是 chrome-extension/manifest.json。该文件定义了 Chrome 扩展的各种配置信息。

{
  "manifest_version": 2,
  "name": "Learning-By-GPT",
  "version": "1.0",
  "description": "A chrome extension helps you learn using AI technology",
  "permissions": [
    "activeTab",
    "storage"
  ],
  "background": {
    "scripts": ["background.js"],
    "persistent": false
  },
  "content_scripts": [
    {
      "matches": ["<all_urls>"],
      "js": ["content.js"]
    }
  ],
  "browser_action": {
    "default_popup": "popup.html",
    "default_icon": {
      "16": "icons/icon16.png",
      "48": "icons/icon48.png",
      "128": "icons/icon128.png"
    }
  }
}

• manifest_version: 指定 manifest 文件的版本。
• name: 扩展的名称。
• version: 扩展的版本号。
• description: 扩展的描述。
• permissions: 扩展所需的权限。
• background: 后台脚本的配置。
• content_scripts: 内容脚本的配置。
• browser_action: 浏览器动作的配置，包括弹出窗口和图标。