Cool-Admin-Midway 使用与安装教程

---

1. 项目目录结构及介绍

Cool-Admin-Midway 是一个基于 Midway.js 的高效后台权限管理框架，其目录结构精心设计，便于模块化和插件化开发。下面是项目的一个基础目录概述：

cool-admin-midway/
├── src                      # 核心源码目录
│   ├── app                  # 应用程序主入口及相关配置
│   │   └── controller       # 控制器层，处理业务逻辑
│   ├── config               # 全局配置文件
│   ├── middleware           # 自定义中间件
│   ├── service              # 服务层，封装数据操作
│   └── swagger              # API 文档相关
├── dist                     # 编译后的生产环境代码
├── ecosystem.config.js      # PM2配置文件，用于部署时进程管理
├── package.json             # 项目依赖与脚本命令
├── tsconfig.json            # TypeScript配置文件
├── ormconfig.ts             # TypeORM数据库连接配置
└── README.md                # 项目说明文档

• src: 包含核心业务逻辑，是开发的主要工作区。
• app: 内含应用的初始化设置、控制器以及路由配置。
• config: 存放全局的配置信息，如数据库配置、环境变量等。
• middleware: 用户自定义的中间件逻辑。
• service: 业务逻辑服务，封装数据库操作等。
• dist: 编译后的代码存放位置，在生产环境中使用。
• ecosystem.config.js: 用于部署环境下的进程管理配置。
• package.json: 定义了项目依赖项和可执行脚本。

---

2. 项目的启动文件介绍

主要的启动文件位于 src/app.ts。在这个文件中，Midway 提供的框架初始化被触发，包括服务容器的创建、加载配置、注册中间件、控制器和服务等。通常，你可以在这里进行一些应用级别的初始化操作，比如设置全局错误处理或调整框架默认行为。

启动命令通常是通过 npm start 或使用 yarn start 来执行，具体脚本定义在 package.json 的 "scripts" 部分。

---

3. 项目的配置文件介绍

tsconfig.json

此文件定义了TypeScript编译选项，确保TS代码正确编译成JavaScript。它指定编译目标、模块系统、源代码路径等关键编译参数。

ormconfig.ts

数据库配置文件，用于设置TypeORM与数据库的交互细节，例如连接字符串、实体模式的位置、同步策略等。是数据库连接的核心配置。

.env（或其它环境变量配置）

虽然直接在引用内容中没有提及.env文件，但一般此类项目会使用环境变量来区分不同环境的配置。基础配置可能包含数据库URL、JWT密钥等敏感信息，应根据实际情况设置。

其他配置（config文件夹下）

• config.default.ts: 包含应用程序的基本配置，如服务器监听端口、日志级别等。
• config.local.ts: 可用于存储本地开发环境的特定配置，这个文件通常不提交到版本控制系统。

确保在部署前，配置好正确的环境变量和数据库连接信息，以便项目能够顺利运行。通过以上结构和配置的理解，开发者可以更轻松地入手开发和管理项目。