# gulp-pc-test

**Repository Path**: lancolin/gulp-pc-test

## Basic Information

- **Project Name**: gulp-pc-test
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-03-19
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 基于gulp搭建的前端自动化构建

**适用于中小型项目，快速构建前端项目框架。比如运营活动页，官网类，简单移动端项目，小demo测试等**
***如果需要使用sass请自行修改gulpfile.js***
## 项目启动
```
// 常用命令
开发环境： npm run dev
生产环境： npm run build

// 单任务命令
执行压缩： gulp zip
编译页面： gulp html
编译脚本： gulp script
编译样式： gulp styles
语法检测： gulp eslint
压缩图片： gulp images
```

```

## 项目目录
```
├── README.md         # 项目说明
├── config            # gulp路径配置
├── dist              # 打包路径
|
├── gulpfile.js       # gulp配置文件
├── package.json      # 依赖包
|
├── src               # 项目文件夹
│   ├── include       # 公用页面引入
│   ├── index.html    # 首页
│   ├── static        # 资源文件夹
│   │   ├── images    # 图库
│   │   ├── js        # 脚本
│   │   └── styles    # 样式（scss,less, css）
│   └── views         # 页面
|
├── static            # 打包到dist中static文件中
└── webpack.config.js # webpack配置文件
```

## 项目约定
1、 使用严格的 eslint 规范 [文档链接](https://github.com/airbnb/javascript)
* 如果不想使用eslint，可以gulpfile文件中去掉该任务

2、使用scss预处理
* 可以根据个人喜好，去配置不同的预处理工具

3、static文件夹
* 一级目录中static文件夹，可以存放不需要编译的文件内容，比如一些插件，图片，字体文件等
* 每次npm run dev or build 都会把static文件夹下的内容，打包到dist/static里

## gulp自动编译HTML静态页
> 每次做静态页都要重新配一次gulp，直接clone可用

## 说明
 1. @@include ：载入html
 2. @@title 使用@@include第二参数中的json属性，title是key
 3. @@include的第二参数必须是json标准，即`{"key":"value"}`格式
 4. 随包搭配`basic-style`，不喜自删
## 安装

## 代理模式
* config/index.js文件中配置

**例子如下**
``` javascript
 middleware: [
  proxy.proxyPrase(
    {
      target: 'http://127.0.0.1:8081/api',
      route: '/api'
    }
  )
]
```

## 使用Eslint 
config/index.js文件
```
useEslint: false // 是否启用eslint
```

## 使用webpack
* 集成webpack功能，可以自行选择

config/index.js文件
```
useWebpack: false // 是否启用webpack
```

## 小生后话
* 此前端自动化构建框架，只是为了简单方便

* 可以随便根据自己的要求去进行修改配置