okam(奥卡姆),一个面向小程序的框架,框架提供了Vue的体验,如果你习惯用Vue,那么你会觉得其更容易上手。
支持 微信小程序、百度小程序和支付宝小程序
一、安装okam脚手架
1、安装 Node(Node >=8 && NPM >= 3):可直接去Node官网直接下载安装包进行安装
2、全局安装 okam-cli 脚手架: npm install okam-cli -g
二、创建一个 okam 项目,项目名自定义(我这里随便取了一个: okam-01)
1、初始化项目
okam init okam-01
2、配置及选择你需要的配置信息及预设
? Project name: okam-01 ----项目名
? Project description: A okam project ----项目描述
? Author wangmeiling<15605022721@163.com> ----创作者
? Please choose template syntax: Normal template ----template 语法
? Please choose script syntax: Javascript(babel6) ----script 语法(我这里选的是 ES6)
? Please choose style syntax: scss/sass ----style 语法(我这里选的是 scss/sass)
? Please input single file component suffix name -----请输入单个文件组件后缀名,默认是 okm(我这里选的是 vue)
? Use Redux in your project? Yes -----是否使用 Redux
? Use Promise, Async/Await in your project? Yes -----是否使用 Promise
? Use px2rpx in your project(designWidth: 1242)? Yes -----是否使用 px2rpx
? Use tinyimg in your project? Yes -----是否使用tinyimg图片压缩工具
? Lint your code? ESLint -----语法规则和代码风格检测工具
3、项目目录解析
.
├── README.md
├── package.json
├── doc // 缓存项目源图片或者其它文档目录
├── dist // 百度小程序 构建产物,开发工具得选择该构建产物目录作为项目根目录方能预览
├── wx_dist // 微信小程序 构建产物,开发工具得选择该构建产物目录作为项目根目录方能预览
├── ant_dist // 支付宝小程序 构建产物,开发工具得选择该构建产物目录作为项目根目录方能预览
├── tt_dist // 头条小程序 构建产物,开发工具得选择该构建产物目录作为项目根目录方能预览
├── .tinyimgcache // 图片压缩的缓存信息,不可删掉,否则会导致图片重复压缩
├── project.json5 // 小程序项目配置文件,除了语法使用 JS 对象形式,配置说明参考官方小程序说明
├── scripts // 构建相关脚本
│ ├── build.js // 构建入口脚本
│ ├── base.config.js // 基础构建配置文件
│ ├── init-quick-app.js // 快应用初始构建配置文件
│ ├── quick.config.js // 快应用构建配置文件
│ ├── tt.config.js // 头条小程序构建配置文件
│ ├── ant.config.js // 支付宝小程序构建配置文件
│ ├── wx.config.js // 微信小程序构建配置文件
│ └── swan.config.js // 百度 Swan 小程序构建配置文件
└── src // 项目源码├── app.js // 小程序入口脚本├── app.scss // 小程序入口样式├── common // 项目公共代码│ ├── img // 项目图片资源│ ├── tpl // 项目公共模板文件│ └── ...├── components // 自定义组件└── pages // 小程序页面集合├── home // 首页├── ...└── ...
4、项目中执行 npm install 安装依赖后,进行对应平台的项目启动,打包,构建等
百度小程序运行命令:
npm run dev 带 watch 开发模式
npm run dev:clean 删掉构建产物(不包括项目配置文件)并重新构建且带 watch 开发模式
npm run dev:server 带 watch && 开发 Server 开发模式
npm run prod 生产环境构建(没有 watch && 开发 Server)微信小程序运行命令:
npm run dev:wx 带 watch 开发模式
npm run dev:wx:clean 删掉构建产物(不包括项目配置文件)并重新构建且带 watch 开发模式
npm run dev:wx:server 带 watch && 开发 Server 开发模式
npm run prod:wx 生产环境构建(没有 watch && 开发 Server)支付宝小程序运行命令:
npm run dev:ant 带 watch 开发模式
npm run dev:ant:clean 删掉构建产物(不包括项目配置文件)并重新构建且带 watch 开发模式
npm run dev:ant:server 带 watch && 开发 Server 开发模式
npm run prod:ant 生产环境构建(没有 watch && 开发 Server)头条小程序运行命令:
npm run dev:tt 带 watch 开发模式
npm run dev:tt:clean 删掉构建产物(不包括项目配置文件)并重新构建且带 watch 开发模式
npm run dev:tt:server 带 watch && 开发 Server 开发模式
npm run prod:tt 生产环境构建(没有 watch && 开发 Server)快应用小程序运行命令:
npm run dev:quick 带 watch 开发模式
npm run dev:quick:clean 删掉构建产物(不包括项目配置文件)并重新构建且带 watch 开发模式
npm run dev:quick:server 带 watch && 开发 Server 开发模式
npm run prod:quick 生产环境构建(没有 watch && 开发 Server)
5、调试
- 1、打包后,得到对应的 dist 包(dist、wx_dist、tt_dist、ant_dist)
- 2、如果是小程序文件,那么就去对应的小程序官网下载开发者工具,直接打开构建后对应的dist包即可
- 3、如果是快应用,那么需要电脑全局安装 hap-toolkit: npm install hap-toolkit -g,手机上安装官网的调试器,启动后用手机进行扫码
- 4、等到调试器进行编译完成,就可以看到效果并进行调试
三、扩展
- 1、如果需要升级你的 okam-cli,可直接执行: okam upgrade self
- 2、如果想升级项目中的依赖:打开项目,在项目中执行 okam upgrade project
就记录到这,祝大家开心~