【亲测免费】 FastGPT 项目使用教程

FastGPT 项目使用教程

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

FastGPT 项目的目录结构如下：

fastGPT/
├── bin/
├── docSite/
├── files/
├── packages/
├── .dockerignore
├── .gitignore
├── .imgbotconfig
├── .npmrc
├── .prettierignore
├── .prettierrc.js
├── LICENSE
├── Makefile
├── README.md
├── README_en.md
├── README_ja.md
├── dev.md
├── package.json
├── pnpm-lock.yaml
├── pnpm-workspace.yaml
├── tsconfig.json

目录介绍

• bin/: 存放项目的可执行文件。
• docSite/: 存放项目的文档站点文件。
• files/: 存放项目的数据文件。
• packages/: 存放项目的子包或模块。
• .dockerignore: Docker 构建时忽略的文件列表。
• .gitignore: Git 版本控制时忽略的文件列表。
• .imgbotconfig: 图片优化配置文件。
• .npmrc: npm 配置文件。
• .prettierignore: Prettier 格式化时忽略的文件列表。
• .prettierrc.js: Prettier 格式化配置文件。
• LICENSE: 项目的开源许可证。
• Makefile: 项目的 Makefile 文件，用于自动化任务。
• README.md: 项目的主 README 文件。
• README_en.md: 项目的英文 README 文件。
• README_ja.md: 项目的日文 README 文件。
• dev.md: 开发相关文档。
• package.json: 项目的 npm 包配置文件。
• pnpm-lock.yaml: pnpm 的锁定文件。
• pnpm-workspace.yaml: pnpm 的工作区配置文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

FastGPT 项目的启动文件主要是 package.json 中的 scripts 部分。以下是一些关键的启动脚本：

{
  "scripts": {
    "start": "node index.js",
    "dev": "nodemon index.js",
    "build": "tsc",
    "test": "jest"
  }
}

启动脚本介绍

• start: 启动生产环境的应用。
• dev: 启动开发环境的应用，使用 nodemon 实现热重载。
• build: 使用 TypeScript 编译项目。
• test: 运行测试用例。

3. 项目的配置文件介绍

FastGPT 项目的配置文件主要包括以下几个：

.prettierrc.js

Prettier 格式化配置文件，用于统一代码风格：

module.exports = {
  singleQuote: true,
  trailingComma: 'all',
  printWidth: 80,
  tabWidth: 2,
};

tsconfig.json

TypeScript 配置文件，用于编译 TypeScript 代码：

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "outDir": "./dist",
    "strict": true,
    "esModuleInterop": true
  },
  "include": ["src/**/*"]
}

package.json

npm 包配置文件，包含项目的依赖、脚本等信息：

{
  "name": "fastGPT",
  "version": "1.0.0",
  "description": "FastGPT is a knowledge-based platform built on the LLMs.",
  "main": "index.js",
  "scripts": {
    "start": "node index.js",
    "dev": "nodemon index.js",
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    "express": "^4.17.1",
    "typescript": "^4.1.3"
  },
  "devDependencies": {
    "nodemon": "^2.0.7",
    "jest": "^26.6.3"
  }
}

以上是