Skip to content

Latest commit

 

History

History
executable file
·
351 lines (282 loc) · 11.1 KB

README.md

File metadata and controls

executable file
·
351 lines (282 loc) · 11.1 KB
Raw

olo

olo 是一个前端自动化工程流框架。

通过 olo 能够一键初始化并快速开发web端项目、基于node服务端渲染的项目、vue项目。整个框架项目是以组件化的方式进行开发，提供服务、热加载功能、生产环境、优化产出环境。有利于团队合作开发。olo 中采用的构建工具是fis3、webpack,可以根据项目需要进行选择。

olo里面包括seo、seo-php、vue模式。

seo、seo-php

  1. 共同点：都是具有PC端SEO优化的工作流程。都采用了node服务，通过fis3进行资源定位及优化。

  2. 区别：

    a. seo-php用的是generator-biketo的开发流程，模版渲染部分由PHP负责。最后产出在后台的服务上运行项目。

    b. seo采用了node服务，以handlebars为模版引擎，实现了页面的自动路由功能。最后产出在node服务上运行。是一种前后端分离的开发模式。

vue

vue模式下提供fis3、webpack2两种构建工具，其中webpack2对es6的编译速度相比于fis3会快一些。

安装

通过npm进行安装

npm i olo -g

基本命令

所有命令的参数都可以通过olo -h、olo ** -h查看。

初始化

olo init  
olo init  -c    // 初始化项目的时候从远端拉取所选择的模版，清除本地缓存模版

初始化项目后，项目启动、监听、产出的脚本命令在 package.json 中的 script 中。

生成视图

olo v view-name

生成组件

olo c component-name

从组件库加载组件

olo i component-name 
olo install component-name

增加第三方包

olo f lib-name

现在olo中有的第三方包有 jquery、ejs、throttle、zepto,运行命令后会将相应的第三方包存放在项目libs文件夹下。

可以运行这些命令： olo f jq ｜ jquery | ejs | throttle | zepto

监听项目

olo w

启动项目中包括清空本地fis3服务文件的server clean，清空编译缓存、自动刷新、实时监听release -clw。

开启服务

olo s

发布

olo r

新建项目

    mkdir my-project
    cd my-project
    olo init
    olo v view-name (可选)
    olo c component-name (可选)
    olo s (或者) npm start
    olo w (或者) npm run watch

模式说明

一. seo

1. 目录结构
|-- assets            # 静态文件目录
    |-- images        # 图片文件
    |-- scss          # 通用样式文件
|-- components/       # 页面组件文件
|-- views/            # 前端页面渲染
|-- libs/             # 前端辅助类或工具类文件
    |-- common.js     # 在此文件引入的第三方插件不会模块化（例：jquery），项目中可以直接用($)
    |-- statistics.js #统计数据，放在html的最后。
|-- mock/             # 模拟数据文件
|-- routes/           # Node路由
    |-- _conf.json    # 路由配置文件
    |-- init.js       # 路由派发规则解析文件
|-- controllers/      # 前端页面渲染路由文件
|-- service/          # 前端接口路由文件
|-- middleware/       # 路由中间件    
|-- utils/            # 后端辅助类或工具类文件
|-- app.js            # 系统启动文件
|-- config.json       # 系统环境配置文件
|-- fis-conf.js       # fis3 配置文件
|-- pm2.json          # pm2 配置文件
|-- package.json      # 管理项⽬的依赖
|-- .editorconfig     # ediforconfig 代码书写配置文件
|-- .eslintrc         # eslint 代码规范性检查配置文件
|-- .gitignore        # git 仓库文件忽略配置
2. 数据模拟

mock数据功能内嵌在node服务中，功能用法和fis文档上说明的一样。[http://fis.baidu.com/fis3/docs/node-mock.html][1]

3. 注意事项

1、 页面路由 controllers>index.js

module.exports = {
    路由名称: ［中间件（可选）,函数］,
    路由名称: 函数,
    index: [midUser.hasLogin,function(req,res){
        res.render('index',{username: req.session.username});
    }]
    index1 : function(req,res){
        res.render('index',{username: req.session.username});
    }
};

2、 页面路由配置 server>_conf.json>controllers

一级路由:接口名称 
一级路由:{  
    二级路由:接口名称
    二级路由/三级路由: 接口名称
    二级路由:{
        三级路由:接口名称
    }
}

(或)

一级路由/二级路由: 接口名称
一级路由/二级路由/```: 接口名称
路由函数名|一级路由:接口名称

1、一级路由默认对应‘路由函数名称’，即：所有路由对应一级路由.js的路由函数。
2、如果需要自定义路由函数可以借助分隔符|,即：路由函数名|一级路由。 3、controllers中路由方式默认是GET。

"controllers": {
    "root": "../controllers",
    "map":{
        "index|/": "index",
        "index": "index",
        "about/member": "member",
        "about/member": {            #默认对应about.js
            "user": "user"
        }
        "about-fn|about/member": {   #对应about-fn.js
            "user": "user"
        }
    }
    
}

3、 接口路由 service>loginout.js

module.exports = {
    路由名称: 函数,
    login : function(req,res){
        //一般在这里进行数据请求
    }
};

4、 接口路由配置 server>_conf.json>service

一级路由:接口名称
一级路由:{
    二级路由:接口名称
}
(或)
一级路由/二级路由: 接口名称

一级路由:［请求方式，接口名称］

1、一级路由默认对应‘路由函数名称’，即：所有路由对应一级路由.js的路由函数。
2、如果需要自定义路由函数可以借助分隔符|,即：路由函数名|一级路由。
3、service中路由方式默认是POST,如果需要get方式，可用：［"get","接口名"］。

"service": {
    "root": "../service",
    "map":{
        "member": "member",
        "auth/login": ["get", "login"],
    }
    
}

二. seo-php

功能、用法与generator-biketo相类似。

目录结构
|-- assets            # 静态文件目录
    |-- images        # 图片文件
    |-- scss          # 通用样式文件
|-- components/       # 页面组件文件
|-- views/            # 前端页面渲染
|-- libs/             # 前端辅助类或工具类文件
    |-- common.js     # 在此文件引入的第三方插件不会模块化（例：jquery），项目中可以直接用($)
    |-- statistics.js #统计数据，放在html的最后。
|-- mock/             # 模拟数据文件
|-- controllers/      # 前端页面渲染路由文件
|-- service/          # 前端接口路由文件  
|-- utils/            # 后端辅助类或工具类文件
|-- app.js            # 系统启动文件
|-- config.json       # 系统环境配置文件
|-- fis-conf.js       # fis3 配置文件
|-- package.json      # 管理项⽬的依赖
|-- .editorconfig     # ediforconfig 代码书写配置文件
|-- .eslintrc         # eslint 代码规范性检查配置文件
|-- .gitignore        # git 仓库文件忽略配置
注意事项

  1. {{#if dev}}handlebars语法区分纯前端开发和后台模板开发；

  2. {{> cmp}}引入组件；

  3. 可以自行加入helper并在 conf.js 中的 handlebars 配置项中配置；

    ​

三. vue

快速初始化 vue 项目框架， 加入了 vuex 进行数据管理。这个模块提供了两种构建工具 fis3、webpack 2， 可根据编码习惯进行选择。两种构建工具都加入了 es6 编译，只是webpack 2 编译速度更快。

vue-webpack

目录结构

|-- assets                  # 静态文件目录
    |-- images              # 图片文件
    |-- scss                # 通用样式文件
|-- build/                  # webpack2 编译配置
|-- config/                 # 项目编译配置
|-- components/             # 页面组件文件
    |-- component/   
    |-- page/   
    |-- main.js             # 页面入口文件
|-- libs/                   # 前端辅助类或工具类文件
    |-- flexible.js   
|-- mock/                   # 模拟数据文件
|-- service/              # 前端接口路由文件 
|-- index.hbs               # 页面入口
|-- package.json            # 管理项⽬的依赖
|-- .bowerrc     
|-- .editorconfig           # ediforconfig 代码书写配置文件
|-- .eslintrc               # eslint 代码规范性检查配置文件
|-- .eslintignore     
|-- .gitignore              # git 仓库文件忽略配置

vue-fis3

这个模式采用的是fis3进行构建

目录结构

|-- assets                  # 静态文件目录
    |-- images              # 图片文件
    |-- scss                # 通用样式文件
|-- components/             # 页面组件文件
    |-- component/   
    |-- page/   
    |-- main.js             # 页面入口文件
|-- libs/                   # 前端辅助类或工具类文件
    |-- flexible.js   
|-- mock/                   # 模拟数据文件
|-- store/                  # vuex文件
    |-- modules/   
    |-- commonHandlers.js   
    |-- mutation-types.js   
    |-- index.js            # vuex入口文件
|-- index.html              # 页面入口
|-- config.json             # 系统环境配置文件
|-- package.json            # 管理项⽬的依赖
|-- fis-conf.js             # fis3 配置文件
|-- .bowerrc    
|-- .editorconfig           # ediforconfig 代码书写配置文件
|-- .eslintrc               # eslint 代码规范性检查配置文件
|-- .eslintignore     
|-- .gitignore              # git 仓库文件忽略配置

更新

v3.1.1

  1. vue-webpack模式relative path、 source map 、free config

v3.1.0

  1. 添加vue-webpack模式 构建
  2. 修复其它模块的BUG

v3.0.0

  1. 添加vue模式工程流
  2. olo模版本地直接拷贝方式改成远程获取并缓存
  3. 添加olo init -c清楚模版缓存初始化项目
  4. 修改远程拉去组件的地址, 通过olo i cmpName获取远程组件

v2.0.16

  1. seo-php模式,mock数据未产出.

v2.0.15

  1. seo模式,生产环境下支持多个项目并行开发.
  2. 增加all形式的路由.

v2.0.14

  1. 解决在fis的开发环境下启动多个项目时，路由有一级路由的问题。

v2.0.13

  1. 支持node 6.x。
  2. 在生产环境下给产出目录添加项目名，方便在fis3自带服务下启动多个项目。
  3. seo-php模式添加common.js。
  4. seo-php模式html的charset改为utf-8。
  5. 添加olo f 框架名，可快速添加常用包。
  6. common.jsajax错误提示更改成console形式。

v2.0.8

  1. seo模式解决.gitignore被NPM改变文件名BUG
  2. seo模式将mock数据功能直接嵌入到服务中，优化开发流程。
  3. seo模式增加gzip压缩功能。
  4. seo模式修改airbnb规范说明。

v2.0.0

  1. seo模式修复路由文件名限制、优化路由、增加无配置文件路由。
  2. seo模式规范通用JS请求。
  3. seo模式增加注释，规范代码，增加eslint,增加airbnb规范。
  4. seo模式嵌入模拟数据。