ChatIE 项目使用教程

1. 项目目录结构及介绍

ChatIE/
├── back-end/
│   ├── run.py
│   ├── config.py
│   └── ...
├── front-end/
│   ├── src/
│   │   ├── App.js
│   │   └── ...
│   ├── public/
│   │   ├── index.html
│   │   └── ...
│   ├── package.json
│   └── ...
├── docs/
│   ├── README.md
│   └── ...
├── LICENSE
└── ...

目录结构说明

• back-end/: 后端代码目录，包含主要的Python脚本和配置文件。
  • run.py: 后端启动文件。
  • config.py: 后端配置文件。
• front-end/: 前端代码目录，包含React应用的源代码和静态文件。
  • src/: 前端源代码目录。
    • App.js: 前端主应用文件。
  • public/: 前端静态文件目录。
    • index.html: 前端入口HTML文件。
  • package.json: 前端依赖管理文件。
• docs/: 项目文档目录，包含README等文档文件。
  • README.md: 项目介绍文档。
• LICENSE: 项目许可证文件。

2. 项目启动文件介绍

后端启动文件

文件路径: back-end/run.py

功能: 该文件是后端的启动脚本，负责启动后端服务。

使用方法:

cd back-end
python run.py

前端启动文件

文件路径: front-end/src/App.js

功能: 该文件是前端React应用的主入口文件，负责渲染前端界面。

使用方法:

cd front-end
npm install
npm run start

3. 项目配置文件介绍

后端配置文件

文件路径: back-end/config.py

功能: 该文件包含后端服务的配置参数，如数据库连接、API密钥等。

配置示例:

# config.py
OPENAI_API_KEY = 'your_openai_api_key'
DATABASE_URL = 'your_database_url'

前端配置文件

文件路径: front-end/package.json

功能: 该文件包含前端项目的依赖包和脚本命令。

配置示例:

{
  "name": "chatie-frontend",
  "version": "1.0.0",
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build"
  },
  "dependencies": {
    "react": "^17.0.2",
    "react-dom": "^17.0.2"
  }
}

通过以上步骤，您可以顺利启动并配置ChatIE项目。