中文教程：如何搭建并使用 `medium-ai` 开源项目-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00929/article/details/142297529

中文教程：如何搭建并使用 `medium-ai` 开源项目

medium-ai An open-source, AI-powered text editor inspired by medium.com. 项目地址: https://gitcode.com/gh_mirrors/me/medium-ai

1. 项目目录结构及介绍

medium-ai 是一个基于AI的文本编辑器，灵感源自Medium平台的界面设计。下面是该项目的目录概览：

medium-ai
├── frontend          # 前端应用代码
│   ├── node_modules  # 前端依赖库（安装后生成）
│   ├── public        # 静态资源文件
│   ├── src           # 主要源代码
│   └── package.json  # 前端包管理配置文件
├── backend           # 后端服务代码
│   ├── app
│   │   ├── config     # 配置文件夹，包含API密钥等
│   │   │   └── env    # 存放OpenAI API Key
│   │   ├── data       # 可能存放编辑数据的目录
│   │   └── main.py    # 后端主要运行文件
│   ├── requirements.txt  # Python依赖列表
│   └── runtime.txt      # （如果存在）Python运行环境要求
└── README.md         # 项目说明文档

前端包含了用户界面和交互逻辑。后台负责处理AI功能请求，如建议生成和文本编辑指令。

2. 项目的启动文件介绍

前端启动文件

主要入口点: frontend/src/index.js 这是React应用程序的入口点，它初始化整个前端应用。

后端启动文件

主要运行脚本: backend/main.py 这个Python脚本启动Flask或其他后端服务器，负责接收前端的请求，与AI模型交互，并返回数据。

3. 项目的配置文件介绍

前端配置：在前端开发中，重要配置通常位于环境变量或特定的.env文件中，但初始不直接提供。
后端配置:
- backend/app/config/env: 此文件用于存储敏感信息，比如OpenAI的API Key。你需要创建这个文件，并按照指示放入你的API密钥，格式为 OPENAI_KEY=your_api_key_here。
- 其他配置可能包含在.env或相关Python文件中，以控制服务器行为，这些可能会随着项目更新而增加。

设置步骤简述

克隆项目：使用Git克隆仓库到本地。
前端设置:
- 进入frontend目录。
- 安装依赖：npm install。
- 启动前端：npm run dev。
后台设置与运行:
- 进入backend目录。
- 创建配置文件config/env，并将OpenAI API Key填入。
- 确保有适当的Python环境，推荐使用Anaconda创建虚拟环境。
- 安装Python依赖：pip install -r requirements.txt。
- 运行服务器：python main.py。