docs(explain): 更新项目说明文档并修改.gitignore规则

更新explain.txt文件,添加了更详细的项目结构说明,包括核心文件、
文件夹介绍和技术栈说明。同时修改.gitignore文件,将images/改为
uploads/images/以更好地反映实际使用的图片上传目录。
```
master
Lmx 2 weeks ago
parent 3ab42b00a3
commit 655b03ea93

5
.gitignore vendored

@ -31,4 +31,7 @@ build/
# 测试覆盖率
coverage/
.nyc_output/
.nyc_output/
# 上传的图片文件夹
uploads/images/

@ -1,12 +1,30 @@
config存放数据库配置
controllers存放接口业务逻辑
models存放数据库模型
routes存放接口路由
middlewares存放中间件暂用不上先创建
### 核心文件和文件夹
- server.js :服务器启动文件,运行后启动后端服务
- app.js :应用主配置文件,设置中间件、路由等
- config/ :配置文件夹
- db.js :数据库连接配置
- controllers/ :控制器文件夹
- userController.js :用户相关功能(如登录)
- productController.js :产品相关功能
- models/ :数据模型文件夹
- User.js :用户数据模型
- Product.js :产品数据模型
- routes/ :路由文件夹
- userRoutes.js :用户相关接口路由
- productRoutes.js :产品相关接口路由
- utils/ :工具函数文件夹
- jwt.js JWT令牌生成工具
- .env.example :环境变量示例文件
- package.json :项目依赖配置文件
.env存放敏感配置如数据库密码不提交到 Git
.env.example环境变量示例给团队参考可提交 Git
app.js应用入口配置中间件和路由
server.js服务启动文件监听端口
db.js 配置数据库连接config/db.js
## 技术栈
### 核心技术
- Node.js JavaScript 运行环境,用于运行后端代码
- Express Web 框架,用于构建 API 接口
- MySQL :关系型数据库,存储用户和产品数据
- Sequelize ORM 库,简化数据库操作
### 辅助工具
- JWT :用于生成和验证身份令牌
- CORS :处理跨域请求,允许前端访问后端接口
- dotenv :管理环境变量,如数据库连接信息
- nodemon :开发时自动重启服务器,提高开发效率

@ -1 +0,0 @@
# This file keeps the images folder in git
Loading…
Cancel
Save