# egg-server-template

**Repository Path**: web_design_of_web_frontend/egg-server-template

## Basic Information

- **Project Name**: egg-server-template
- **Description**: 一个简单的后台管理系统
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-08-12
- **Last Updated**: 2025-08-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# egg-server-template

这是一个基于Egg.js框架的后端服务基础模板项目。
包括：用户管理、角色管理、部门管理、字典配置、系统配置、菜单管理、图片上传模块。
本系统由AI生成。

前端地址：https://gitee.com/web_design_of_web_frontend/vue-admin-template

## 目录结构

```
app/
  controller/     # 控制器，处理HTTP请求
  middleware/     # 自定义中间件
  model/          # 数据库模型
  public/         # 静态资源文件
  router.js       # 路由定义
  service/        # 业务逻辑层
  utils/          # 工具函数
config/
  config.default.js  # 默认配置文件
  database.js        # 数据库配置
  plugin.js          # 插件配置
database/
  migrations/        # 数据库迁移文件
  seeders/           # 数据库种子文件
test/                # 测试文件
  app/               # 应用测试
```

## 接口文档

详细的API接口文档请查看 [API文档](./API.md)

## 安装

在首次使用项目时，需要安装依赖包：

```bash
npm install
```

## 开发运行

安装依赖后，可以通过以下命令启动开发服务器：

```bash
npm run dev
```

启动后访问 http://localhost:7001/ 查看应用。

## 脚本执行

项目提供了多个npm脚本用于不同的开发任务：

- `npm run lint` - 检查代码风格
- `npm test` - 运行单元测试
- `npm run cov` - 运行测试并生成覆盖率报告
- `npm run autod` - 自动更新依赖


## 数据库迁移

本项目使用Sequelize进行数据库操作。

运行迁移：

```bash
npx sequelize-cli db:migrate
```

生成新的迁移文件：

```bash
npx sequelize-cli migration:generate --name migration-name
```
执行种子文件：

```bash
npx sequelize-cli db:seed:all
```

## 部署

使用以下命令进行生产环境部署：

```bash
npm install --production
npm start
```

停止服务：

```bash
npm stop
```

## 更多信息

有关Egg.js的更多信息，请参考 [egg docs][egg]。

[egg]: https://eggjs.org