egg-tell-basic

基于EggJS的企业内部框架

技术选型

数据库

• 文档型数据库：MongoDB
• 高性能缓存：Redis
• 对象云存储：OSS

插件

• 表单验证插件：egg-validate
• 跨域设置插件：egg-cors
• 国际化插件：egg-i18n

辅助

• 性能监控平台：alinode
• 时间处理工具库：momentjs

如何使用

安装模块

npm i egg-tell-basic

引入框架

在 package.json 指定 egg.framework，默认为 egg

{
  "egg": {
    "declarations": true,
    "framework": "egg-tell-basic"
  },
  "dependencies": {
    "egg": "^2.15.1",
    "egg-scripts": "^2.11.0",
    "egg-tell-basic": "^1.0.5"
  },
}

添加配置

指定配置文件覆盖数据库地址

// 文档型数据库
config.mongoose = {
    url: 'mongodb://localhost:27017/teller',
    options: {
        useNewUrlParser: true,
        autoIndex: true,
        useCreateIndex: true,
    },
};

// 高性能缓存
config.redis = {
    client: {
        host: process.env.EGG_REDIS_HOST || '127.0.0.1',
        port: process.env.EGG_REDIS_PORT || 6379,
        password: process.env.EGG_REDIS_PASSWORD || '',
        db: process.env.EGG_REDIS_DB || '10',
    },
};

// 安全设置
config.security = {
    domainWhiteList: [],
    csrf: {
      enable: false,
    },
};

// 性能监控
config.alinode = {
    appid: '',
    secret: '',
};

// 国际化
config.i18n = {
    defaultLocale: 'zh-CN',
};

默认插件配置

• mongoose
• redis
• validate
• cors
• alinode

集成开发环境

建议使用VSCode，并添加如下扩展

• eggjs，本地调试应用
• ESLint，检测代码质量
• vscode-icons，美化大纲排版