cool-admin-api 项目启动与配置教程

cool-admin-api 项目启动与配置教程

cool-admin-api cool-admin-api 是基于egg.js、typeorm、jwt等封装的api开发脚手架、快速开发api接口 项目地址: https://gitcode.com/gh_mirrors/co/cool-admin-api

1. 项目目录结构及介绍

cool-admin-api 是一个基于 egg.js、typeorm、jwt 等技术的后端 API 开发脚手架。项目目录结构如下：

cool-admin-api/
├── app/                    # 应用目录，包含业务逻辑
│   ├── controller/         # 控制器目录
│   ├── service/            # 服务层目录
│   ├── entities/           # 数据模型目录
│   ├── middleware/         # 中间件目录
│   └── router.js           # 路由配置文件
├── config/                 # 配置目录
│   ├── config.default.js   # 默认配置文件
│   ├── config.local.js     # 本地开发配置文件
│   └── plugin.js           # 插件配置文件
├── test/                   # 测试目录
├── .gitignore              # git 忽略文件
├── package.json            # 项目依赖和配置
├── tsconfig.json           # TypeScript 配置文件
└── tslint.json             # TypeScript 代码风格配置文件

2. 项目的启动文件介绍

项目的启动文件是 package.json 文件中的 scripts 部分，定义了启动和运行项目的命令。

"scripts": {
  "dev": "egg-bin dev",
  "start": "egg-bin start",
  "stop": "egg-bin stop",
  "test": "egg-bin test"
}

• npm run dev: 启动开发模式，项目将监听文件变化并自动重启。
• npm start: 启动生产模式，用于正式部署。
• npm stop: 停止项目。
• npm test: 运行测试。

3. 项目的配置文件介绍

项目的配置文件主要集中在 config/ 目录下。

config.default.js

这是项目的默认配置文件，包含了所有环境的默认配置。以下是一些重要配置项：

module.exports = appInfo => {
  const config = {};

  // 中间件配置
  config.middleware = ['responseTime'];

  // 类型orm配置
  config.typeorm = {
    type: 'mysql',
    host: '127.0.0.1',
    port: 3306,
    username: 'root',
    password: 'root',
    database: 'cool_admin',
    synchronize: true,
    logging: false,
  };

  // jwt 配置
  config.jwt = {
    secret: 'cool-admin-secret',
    expire: '1h',
  };

  return config;
};

config.local.js

这是本地开发环境的配置文件，用于覆盖默认配置。通常，你会在这里配置数据库连接信息和其他本地特定的配置。

module.exports = {
  // 本地数据库配置
  typeorm: {
    host: '127.0.0.1',
    port: 3306,
    username: 'your_username',
    password: 'your_password',
    database: 'your_database',
  },
  // 其他本地配置...
};

plugin.js

插件配置文件，用于启用或禁用插件，并可以配置插件参数。

module.exports = {
  // 启用 egg-redis 插件
  redis: {
    enable: true,
    package: 'egg-redis',
  },
  // 其他插件配置...
};

以上就是 cool-admin-api 项目的启动和配置文档。在实际开发中，你可能需要根据实际需求调整配置文件以满足不同环境的要求。

cool-admin-api cool-admin-api 是基于egg.js、typeorm、jwt等封装的api开发脚手架、快速开发api接口 项目地址: https://gitcode.com/gh_mirrors/co/cool-admin-api