❤
npm
Sign UpSign In

egg-vgg

0.4.5 • Public • Published

egg-vgg

使eggjs支持前端vgg框架。

特性：

  • 服务端渲染。
  • 静态资源构建和部署。
  • 热更新。

依赖：

1. 快速开始

  1. 安装依赖
  2. 建立目录
  3. 启用插件
  4. 写个hello world
  5. 运行
  6. 构建和部署

1.1 安装依赖

  npm i vgg egg egg-vgg egg-view-vue egg-webpack@3.0.2 egg-bin egg-scripts

1.2 建立目录

  - app
    - view          // [必须]eggjs的视图层，可以使空目录。
    - web           // [必须]前端工程目录，例如vgg工程 https://github.com/acthtml/vgg
  - config          // egg配置目录。
    - config.default.js
    - plugin.js
  - babel.config.js // [必须]babel配置
  - package.json

完善package.json和babel.config.js：

  // 在package.json中添加dev指令：
  {
    "scripts": {
      "dev": "egg-bin dev"
    }
  }
  // 添加 /babel.config.js
  module.exports = api => {
    api.cache(true);
    return {
      "presets": [
        [
          "@babel/preset-env",
          {
            "modules": false,
            "useBuiltIns": "usage",
            "targets": {
              "browsers": [
                "> 1%",
                "last 2 versions",
                "not ie <= 8"
              ],
              "node": "current"
            }
          }
        ]
      ],
      "plugins": [
        "@babel/plugin-proposal-object-rest-spread",
        "@babel/plugin-syntax-dynamic-import",
        "@babel/plugin-transform-async-to-generator",
        "@babel/plugin-transform-runtime"
      ]
    }
  }

1.3 eggjs启用插件

  // ${app.baseDir}/config/plugin.js
  module.exports = {
    vgg: {
      enable: true,
      package: 'egg-vgg'
    },
    // egg-view-vue https://github.com/eggjs/egg-view-vue
    vue: {
      enable: true,
      package: 'egg-view-vue'
    },
    // egg-webpack https://github.com/easy-team/egg-webpack
    webpack: {
      enable: true,
      package: 'egg-webpack'
    }
  }
 
  // 设置cookie秘钥。
  // ${app.baseDir}/config/config.default.js
  // https://eggjs.org/en/core/cookie-and-session.html#cookie-secret-key
  exports.keys = '我的cookie秘钥'
 

1.4 hello world

写个案例练个手，需要新建以下文件：

  在/app/web目录下：

  - app
    - web
      - router
        - routes.js    // 新增路由文件
      - views
        - hello.vue    // 新增页面组件
  - ...其他文件

注册页面路由：

  // router/routes.js
  export default [{
    path: '/',
    component: () => import('../views/hello.vue')
  }]
  <template>
    <p>你好，现在时间是：{{time}}</p>
  </template>
  <script>
    export default {
      data(){
        return {
          time: ''
        }
      },
      created(){
        this.time = new Date().toString();
      }
    }
  </script> 

刷新http://localhost:7001/app/看看有什么变化。

1.5 运行

  # 开启本地开发模式，具有热加载功能。 
  # 编译完成后访问 http://localhost:7001/app/ 
  npm run dev

1.6 构建和部署

添加构建命令和生产环境运行命名。

  // package.json
  {
    "scripts": {
      "dev": "egg-bin dev",
      "build": "vgg-build",
      "start": "eggctl start"
    }
  }
  # 设置生产环境 
  export EGG_SERVER_ENV=prod
 
  # 构建静态资源，产物在public/static里。 
  npm run build
 
  # 生产环境运行，关闭热加载。 
  npm start

2. 进阶

2.1 webpack配置和cdn设置

  // 开本地开发是，我们一般需要开启热加载：
  // /config/config.local.js
  const webpackConfig = require('vgg/tools/webpack_config');
  exports.webpack = {
    webpackConfigList: [
      webpackConfig('client', 'local', {enableHMR: true}),
      webpackConfig('server', 'local', {enableHMR: true})
    ]
  }
 
  // 在生产环境，我们需要关闭热加载，并将静态资源我们是会放到cdn上的：
  // /config/config.prod.js
  const webpackConfig = require('vgg/tools/webpack_config');
  exports.webpack = {
    webpackConfigList: [
      webpackConfig('client', 'prod', {
        client: {
          publicPath:'//cdn.example.com/'
        }
      }),
      webpackConfig('server', 'prod', {
        client: {
          publicPath:'//cdn.example.com'
        }
      })
    ]
  }
  // 更多配置查看： https://github.com/easy-team/egg-webpack
 

2.2 vue服务端渲染设置

  // 参考： https://github.com/eggjs/egg-view-vue
  // {app_root}/config/config.default.js
  exports.vue = {
     // renderOptions config, please @see https://ssr.vuejs.org/en/api.html#renderer-options
     renderOptions: {
       // template: '<!DOCTYPE html><html lang="en"><body><!--vue-ssr-outlet--></body></html>',
 
       // webpack vue ssr plugin build manifest file
       // clientManifest: require(path.join(app.baseDir,'public/vue-ssr-client-manifest.json')),
     }
  };

2.3 vgg插件配置

  exports.vgg = {
    // 站点根目录，以'/'结尾。
    siteRoot: '/app/',
    // 是否开启热更新，默认只在local环境开启热加载。
    enableHMR: false,
    // 编写上下文，
    composeContext: (context, ctx) => {
      // 默认包含以下属性
      return {
        // 页面url，不包含根目录。
        url: context.url
        // 站点根目录
        siteRoot: context.siteRoot,
        // cookies
        cookies: ctx.cookies,
        // koa ctx
        ctx: ctx
      }
    },
    // 是否开启[vconsole.log](https://github.com/WechatFE/vConsole)
    enableVConsole: false,
    // 是否开启service worker来缓存前端资源
    // @todo
    enableServiceWorker: false
  }

Readme

Keywords

none

Package Sidebar

Install

npm i egg-vgg

Repository

github.com/acthtml/egg-vgg

Homepage

github.com/acthtml/egg-vgg#readme

Weekly Downloads

39

Version

0.4.5

License

none

Unpacked Size

16.8 kB

Total Files

11

Last publish

Collaborators

  • acthtml
Try on RunKit
Report malware