WordPecker App 项目使用教程
项目地址: https://gitcode.com/gh_mirrors/wo/wordpecker-app 1. 项目目录结构及介绍
WordPecker App 是一个个性化的语言学习工具，它的目录结构如下：
wordpecker-app/
├── backend/ # 后端代码目录
├── frontend/ # 前端代码目录
├── .gitignore # Git 忽略文件
├── LICENSE # 项目许可证文件
├── README.md # 项目说明文件
backend/
后端代码目录包含了 Node.js 应用程序的所有代码，使用 Express.js 框架构建。
backend/
├── .env # 环境变量文件
├── package.json # 项目依赖及配置文件
├── package-lock.json # 项目依赖锁定文件
├── src/ # 源代码目录
│ ├── config/ # 配置文件目录
│ ├── controllers/ # 控制器目录
│ ├── models/ # 数据模型目录
│ ├── routes/ # 路由目录
│ └── utils/ # 工具函数目录
└── ...
frontend/
前端代码目录包含了 React.js 应用程序的所有代码，使用 TypeScript 进行类型检查。
frontend/
├── .env # 环境变量文件
├── package.json # 项目依赖及配置文件
├── package-lock.json # 项目依赖锁定文件
├── public/ # 公共文件目录
├── src/ # 源代码目录
│ ├── components/ # 组件目录
│ ├── pages/ # 页面目录
│ ├── services/ # 服务目录
│ ├── store/ # 状态管理目录
│ └── ...
└── ...
.gitignore
该文件指定了 Git 应该忽略的文件和目录。
LICENSE
项目使用 MIT 许可证。
README.md
项目说明文件，包含了项目的介绍、安装和使用指南。
2. 项目的启动文件介绍
项目的启动主要是通过运行前端和后端目录中的特定脚本。
后端启动
在 backend 目录中，使用以下命令启动后端服务：
cd backend
npm run dev
前端启动
在 frontend 目录中，使用以下命令启动前端服务：
cd frontend
npm run dev
3. 项目的配置文件介绍
配置文件用于定义项目运行时需要的环境变量和设置。
后端配置文件
在 backend 目录中，.env 文件包含了以下配置：
PORT= # 服务端口
OPENAI_BASE_URL= # OpenAI API 基础URL
OPENAI_API_KEY= # OpenAI API 密钥
SUPABASE_URL= # Supabase 服务URL
SUPABASE_SERVICE_KEY= # Supabase 服务密钥
前端配置文件
在 frontend 目录中，.env 文件包含了以下配置：
VITE_SUPABASE_URL= # Supabase 服务URL
VITE_SUPABASE_ANON_KEY= # Supabase 匿名访问密钥
VITE_API_URL= # 后端API服务URL
确保在开始项目之前正确配置这些环境变量，以保障项目能够正确运行。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
