Skip to content

emondora/webpack-seed

 
 

Repository files navigation

webpack-seed

项目介绍

本项目是一个利用webpack架构的web app脚手架,其特点如下:

  • 更适合多页应用。
  • 既可实现全后端分离,也可以生成后端渲染所需要的模板。
  • 引入layout和component的概念,方便多页面间对布局、组件的重用,妈妈再也不用担心我是选SPA呢还是Iframe了,咱们都!不!需!要!
  • 编译后的程序不依赖于外部的资源(包括css、font、图片等资源都做了迁移),可以整体放到CDN上。
  • 已整合兼容IE8+的跨域方案。
  • 整合Bootstrap3(利用webpack按需打包)及主题SB-Admin,但其实换掉也很简单,或者干脆不用CSS框架也行。
  • 不含Js框架(jQuery不算框架,谢谢)。在我原本的项目中,是用avalon2作为Js框架的,但考虑到脚手架本身并不需要Js框架,同时我也希望这个项目保持精简,因此决定剔除掉avalon2的部分。
  • 整合iconfont作为字体图标方案,需要什么图标就自己上iconfont那打包下载下来,替换掉src/public-resource/iconfont内的文件。

使用说明

  1. 本项目使用包管理工具NPM,因此需要先把本项目所依赖的包下载下来:
$ npm install --no-optional
  1. 编译程序,生成的所有代码在build目录内。
$ npm run build # 生成生产环境的代码。用npm run watch或npm run dev可生成开发环境的代码
  1. 启动服务器,推荐直接使用webpack-dev-server
$ webpack-dev-server
  1. 打开浏览器,在地址栏里输入http://localhost:8080,Duang!页面就出来了!

目录结构说明

├─build # 编译后生成的所有代码、资源(图片、字体等,虽然只是简单的从源目录迁移过来)
├─node_modules # 利用npm管理的所有包及其依赖
├─vendor # 所有不能用npm管理的第三方库
├─.babelrc # babel的配置文件
├─.eslintrc # ESLint的配置文件
├─index.html # 仅作为重定向使用
├─package.json # npm的配置文件
├─webpack-config # 存放分拆后的webpack配置文件
│   ├─base # 主要是存放一些变量
│   ├─inherit # 存放生产环境和开发环境相同的部分,以供继承
│   └─vendor # 存放webpack兼容第三方库所需的配置文件
├─webpack.config.js # 生产环境的webpack配置文件(无实质内容,仅为组织整理)
├─webpack.dev.config.js # 开发环境的webpack配置文件(无实质内容,仅为组织整理)
├─src # 当前项目的源码
    ├─pages # 各个页面独有的部分,如入口文件、只有该页面使用到的css、模板文件等
    │  ├─alert # 业务模块
    │  │  └─index # 具体页面
    │  ├─index # 业务模块
    │  │  ├─index # 具体页面
    │  │  └─login # 具体页面
    │  │      └─templates # 如果一个页面的HTML比较复杂,可以分成多块再拼在一起
    │  └─user # 业务模块
    │      ├─edit-password # 具体页面
    │      └─modify-info # 具体页面
    └─public-resource # 各个页面使用到的公共资源
        ├─components # 组件,可以是纯HTML,也可以包含js/css/image等,看自己需要
        │  ├─footer # 页尾
        │  ├─header # 页头
        │  ├─side-menu # 侧边栏
        │  └─top-nav # 顶部菜单
        ├─config # 各种配置文件
        ├─iconfont # iconfont的字体文件
        ├─imgs # 公用的图片资源
        ├─layout # UI布局,组织各个组件拼起来,因应需要可以有不同的布局套路
        │  ├─layout # 具体的布局套路
        │  └─layout-without-nav # 具体的布局套路
        ├─less # less文件,用sass的也可以,又或者是纯css
        │  ├─base-dir
        │  ├─components-dir # 如果组件本身不需要js的,那么要加载组件的css比较困难,我建议可以直接用less来加载
        │  └─base.less # 组织所有的less文件
        ├─libs # 与业务逻辑无关的库都可以放到这里
        └─logic # 业务逻辑

更新日志

1.0.2

  • 编译文件前先清空build目录。
  • 分拆webpack配置文件,避免配置文件日益臃肿。
  • 分开生产环境和开发环境的webpack配置文件。其中,npm run build会调用生产环境的webpack配置文件(webpack.config.js),而npm run devnpm run watch会调用开发环境的配置文件。

1.0.0

由于本脚手架是直接从我负责的项目中提炼出来的,因此已具备投入生产环境的能力,故直接定义版本号为1.0.0

About

This is a seed for programe built by webpack

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 41.5%
  • JavaScript 35.7%
  • CSS 22.8%