awesome-okam / okam-template

The okam project template

Okam Project Template

基于 okam 开发框架开发的小程序项目模板

快速开始

准备工作

• 安装 Node (Node >= 8 && npm >= 3)

• 执行 npm install

开发

• 百度小程序运行命令

  • 带 watch 开发模式：npm run dev

  • 删掉构建产物（不包括项目配置文件）并重新构建且带 watch 开发模式：npm run dev:clean

  • 带 watch && 开发 Server 开发模式：npm run dev:server

  • 删掉构建重新构建（没有 watch && 开发 Server）：npm run build

  • 生产环境构建：npm run prod

• 微信小程序运行命令

  • 微信小程序开发构建：npm run dev:wx

  • 微信小程序：删掉构建产物（不包括项目配置文件）并重新构建且带 watch 开发模式：npm run dev:wx:clean

  • 带 watch && 开发 Server 开发模式：npm run dev:wx:server

  • 微信小程序生产环境构建：npm run prod:wx

• 支付宝小程序运行命令

  • 微信小程序开发构建：npm run dev:ant

  • 微信小程序：删掉构建产物（不包括项目配置文件）并重新构建且带 watch 开发模式：npm run dev:ant:clean

  • 带 watch && 开发 Server 开发模式：npm run dev:ant:server

  • 微信小程序生产环境构建：npm run prod:ant

目录结构说明

.
├── README.md
├── package.json
├── doc                 // 缓存项目源图片或者其它文档目录
├── dist                // 构建产物，开发工具得选择该构建产物目录作为项目根目录方能预览
├── .tinyimgcache       // 图片压缩的缓存信息，不可删掉，否则会导致图片重复压缩
├── project.json5       // 小程序项目配置文件，除了语法使用 JS 对象形式，配置说明参考官方小程序说明
├── scripts             // 构建相关脚本
│   ├── build.js        // 构建入口脚本
│   ├── build.sh        // CI 脚本
│   ├── base.config.js  // 基础构建配置文件
│   ├── wx.config.js    // 微信小程序构建配置文件
│   └── swan.config.js  // 百度 Swan 小程序构建配置文件
└── src                 // 项目源码
    ├── app.js          // 小程序入口脚本
    ├── app.styl        // 小程序入口样式
    ├── common          // 项目公共代码
    │   ├── biz         // 项目公共业务代码
    │   ├── css         // 项目公共基础样式
    │   ├── img         // 项目图片资源
    │   └── tpl         // 项目公共模板文件
    ├── components      // 自定义组件
    └── pages           // 小程序页面集合
        ├── home        // 首页
        ├── ...
        └── ...