# mask_api_midwayjs

**Repository Path**: TsMask/mask_api_midwayjs

## Basic Information

- **Project Name**: mask_api_midwayjs
- **Description**: 【Node】🎉 基于 Midwayjs 的管理系统后端接口服务
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://env-00jxgaqjulpu-static.normal.cloudstatic.cn/index.html
- **GVP Project**: No

## Statistics

- **Stars**: 79
- **Forks**: 30
- **Created**: 2022-09-07
- **Last Updated**: 2026-06-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: TypeScript, midway

## README

# 基于 Midwayjs 的管理系统后端接口服务

[![star](https://gitee.com/TsMask/mask_api_midwayjs/badge/star.svg?theme=dark)](https://gitee.com/TsMask/mask_api_midwayjs/stargazers)
![Build Midwayjs](https://img.shields.io/badge/Build-Midway-green.svg)
![Release V0.7.2](https://img.shields.io/badge/Release-V0.7.2-orange.svg)
![License MIT](https://img.shields.io/badge/License-MIT-blue.svg)

## 介绍

该项目选择 [RuoYi-Vue](https://gitee.com/y_project/RuoYi-Vue) 后端进行重构改造。

基于 `Node` + `TypeScript` 的 `Midwayjs` 开发框架进行开发，如需进一步了解框架，参见 [Midwayjs](http://www.midwayjs.org) 官方文档。

## 项目文档

- 项目代码进行服务器部署的网站 => [在线预览](http://124.223.91.248:8102/#/)
- `Apifox` 提供mock服务和程序接口文档 => [接口文档](https://mask-api-midwayjs.apifox.cn/)
- `Mask管理系统` 文档专栏，相关使用和开发升级文档。 => [专栏](https://juejin.cn/column/7188761626017792056/)

### 前端

- `Vue3-Element` 仓库地址 => [mask_vue3_element](https://gitee.com/TsMask/mask_vue3_element)
- `Vue3-Antd` 仓库地址 => [mask_vue3_antd](https://gitee.com/TsMask/mask_vue3_antd)

### 后端

- `Node-Midwayjs` 仓库地址 => [mask_api_midwayjs](https://gitee.com/TsMask/mask_api_midwayjs)
- `Go-Gin` 仓库地址 => [mask_api_gin](https://gitee.com/TsMask/mask_api_gin)

## 内置功能

1. 用户管理：用户是系统操作者，该功能主要完成系统用户配置。
2. 部门管理：配置系统组织机构，树结构展现支持数据权限。
3. 岗位管理：配置系统用户所属担任职务。
4. 菜单管理：配置系统菜单，操作权限，按钮权限标识等。
5. 角色管理：角色菜单权限分配、设置角色按机构进行数据范围权限划分。
6. 字典管理：对系统中经常使用的一些较为固定的数据进行维护。
7. 参数管理：对系统动态配置常用参数。
8. 通知公告：系统通知公告信息发布维护。
9. 系统日志：系统正常操作日志记录和查询；系统异常信息日志记录和查询。
10. 登录日志：系统登录日志记录查询包含登录异常。
11. 在线用户：当前系统中活跃用户状态监控。
12. 调度任务：在线（添加、修改、删除）任务调度包含执行结果日志。
13. 服务监控：监视当前系统CPU、内存、磁盘、堆栈等相关信息。
14. 缓存监控：对系统的缓存信息查询，命令统计。

## 项目结构

```text
mask_api_midwayjs
├── src                         目录-源代码
│   ├── assets                  目录-程序内部静态资源文件
│   ├── config                  目录-程序相关运行参数配置
│   ├── framework               目录-程序核心通用代码
│   │   ├── utils               目录-通用工具函数
│   │   ├── ip2region           目录-IP归属地查询
│   │   └── ...
│   ├── modules                 目录-业务模块
│   │   ├── system              目录-系统内部接口模块
│   │   │   ├── controller      目录-接口路由控制层
│   │   │   ├── model           目录-数据对象模型层
│   │   │   ├── repository      目录-CURD数据存储层
│   │   │   ├── service         目录-业务逻辑服务层
│   │   │   └── middleware       目录-中间件
│   │   └── ...
│   ├── typings                 目录-程序通用类型定义
│   ├── configuration.ts        文件-程序框架启动入口
│   └── interface.ts            文件-程序通用接口函数自定义声明
├── docs                        目录-项目文档
├── script                      目录-数据库脚本与部署配置
├── test                        目录-测试单元
├── .env                        文件-本地环境变量配置（不提交）
├── .env.example                文件-环境变量模板
├── bootstrap.js                文件-程序部署PM2启动运行入口
├── eslint.config.js            文件-ESLint代码规范配置
├── jest.config.js              文件-单元测试配置
├── package.json                文件-程序依赖及启动命令信息
└── tsconfig.json               文件-TypeScript编译配置
```

## 快速启动

你需要先安装准备 **开发环境** 后使用 **程序命令**

### 开发环境

| 技术 | 说明 | 版本 |
| ---- | ---- | ---- |
| Node.js | node项目的运行环境 | 24+ |
| Redis | 缓存存储程序 | 6+ |
| MySQL | 数据存储程序 | 8+ |

程序可用脚本 `script` 目录内含初始化数据库SQL脚本文件

### 环境变量

复制 `.env.example` 为 `.env`，根据实际情况修改数据库、Redis、JWT等配置参数。

```bash
cp .env.example .env
```

### 程序命令

#### 本地开发

```bash
# 修改配置参数 /src/connfig/config.local.ts
npm install                 # 安装项目所需依赖
npm run dev                 # 开发模式启动项目

open http://localhost:6275  # 启动成功后得到服务访问地址
```

#### 生产部署

```bash
# 修改配置参数 /src/connfig/config.prod.ts
npm install             # 安装项目所需依赖
npm run build           # 构建生产项目代码

npm prune --omit=dev    # 清理开发依赖包，缩减生产环境体积大小（可选）

npm run start           # 窗口当前启动项目
npm run start:pm2       # PM2常驻启动项目（推荐）
```

#### 内置指令

| 命令 | 说明 |
| ---- | ---- |
| `npm run dev` | 开发模式启动 |
| `npm run build` | TypeScript编译构建 |
| `npm run start` | 生产模式启动 |
| `npm run start:pm2` | PM2常驻启动 |
| `npm run test` | 执行单元测试 |
| `npm run cov` | 代码覆盖率检查 |
| `npm run lint` | 代码风格检查 |
| `npm run lint:fix` | 代码风格检查并修复 |

更多部署信息请移步 [Midway-启动和部署](http://www.midwayjs.org/docs/deployment)。

> 有任何问题或者建议，可以在 [_Issues_](https://gitee.com/TsMask/mask_api_midwayjs/issues) 或通过QQ群：[_57242844_](https://jq.qq.com/?_wv=1027&k=z6Y4YQcB) 提出想法。
> 如果觉得项目对您有帮助，可以来个Star ⭐

## 相关框架

| 名称 | 说明 | 地址 |
| ---- | ---- | ---- |
| RuoYi-Vue | 基于SpringBoot+Vue前后端分离的Java快速开发框架 | [Gitee仓库](https://gitee.com/y_project/RuoYi-Vue) |
| RuoYi-Vue-Plus | RuoYi-Vue-Plus 是重写 RuoYi-Vue 针对 分布式集群 场景全方位升级(不兼容原框架) | [Gitee仓库](https://gitee.com/dromara/RuoYi-Vue-Plus) |
| AgileBoot | 基于SpringBoot+Vue3前后端分离的Java快速开发脚手架 | [Gitee仓库](https://gitee.com/valarchie/AgileBoot-Back-End) |