Egg-Beehive 项目教程

Egg-Beehive 项目教程

egg-beehive🖖基于Vue+Egg.js的JS全栈项目。动态菜单，RBAC权限模型，Websocket实现站内信。项目地址:https://gitcode.com/gh_mirrors/eg/egg-beehive

1. 项目的目录结构及介绍

Egg-Beehive 是一个基于 Vue 和 Egg.js 的全栈项目，其目录结构如下：

egg-beehive/
├── app/
│   ├── controller/
│   ├── service/
│   ├── model/
│   ├── router.js
│   └── ...
├── config/
│   ├── config.default.js
│   ├── config.local.js
│   └── ...
├── database/
│   ├── egg-beehive-dev.sql
│   └── egg-beehive-test.sql
├── generator/
│   ├── config.js
│   └── ...
├── test/
│   └── ...
├── package.json
└── README.md

目录结构介绍

• app/: 包含应用程序的主要代码，包括控制器、服务、模型和路由。
• config/: 包含项目的配置文件，如默认配置、本地配置等。
• database/: 包含数据库的 SQL 文件，用于初始化数据库。
• generator/: 包含代码生成器的配置文件，用于自动生成代码。
• test/: 包含项目的测试文件。
• package.json: 项目的依赖管理文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件主要位于 app/router.js 和 config/config.default.js 中。

app/router.js

router.js 文件定义了项目的路由规则，是项目启动的关键文件之一。

// app/router.js
module.exports = app => {
  const { router, controller } = app;
  router.get('/', controller.home.index);
  // 其他路由规则
};

config/config.default.js

config.default.js 文件包含了项目的默认配置，如数据库连接、Redis 配置等。

// config/config.default.js
exports.keys = 'your-cookie-secret';
exports.sequelize = {
  dialect: 'mysql',
  host: '127.0.0.1',
  port: 3306,
  database: 'egg-beehive',
  username: 'root',
  password: '',
};
exports.redis = {
  client: {
    host: '127.0.0.1',
    port: 6379,
    password: '',
    db: 0,
  },
};

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 目录下，包括 config.default.js、config.local.js 等。

config.default.js

config.default.js 文件包含了项目的默认配置，如数据库连接、Redis 配置等。

// config/config.default.js
exports.keys = 'your-cookie-secret';
exports.sequelize = {
  dialect: 'mysql',
  host: '127.0.0.1',
  port: 3306,
  database: 'egg-beehive',
  username: 'root',
  password: '',
};
exports.redis = {
  client: {
    host: '127.0.0.1',
    port: 6379,
    password: '',
    db: 0,
  },
};

config.local.js

config.local.js 文件用于本地开发环境的配置，可以覆盖默认配置。

// config/config.local.js
module.exports = appInfo => {
  const config = {};
  config.sequelize = {
    host: 'localhost',
    username: 'dev',
    password: 'dev-password',
  };
  return config;
};

以上是 Egg-Beehive 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用该项目。

egg-beehive🖖基于Vue+Egg.js的JS全栈项目。动态菜单，RBAC权限模型，Websocket实现站内信。项目地址:https://gitcode.com/gh_mirrors/eg/egg-beehive