Skip to content

kunlunjs/miniapp-boilerplate

Repository files navigation

XXX 小程序

基于Taro的多端小程序开发项目模板。

对比其它开发框架

  • uni-app Vue 技术栈,与我们主要技术栈不同,但生态相对丰富很多
  • Remax 做跨多端应用上会稍微复杂点,如果只是微信小程序,也可以使用。其它参见https://remaxjs.org/faq#%E4%B8%8E-taro-%E7%9A%84%E5%8C%BA%E5%88%AB%EF%BC%9F

Get started

  1. 安装
# 如果没有全局安装 pnpm 的话
npm install -g pnpm
pnpm i
  1. 开发
# 默认启动微信小程序开发环境
# 其它环境请参考 package.json 中的 scripts 脚本
pnpm dev

然后使用开发工具打开dist目录即可。

  1. 调试

使用扫码调试时可能遇到包体积过大而无法预览的问题,这时可以添加环境变量NODE_ENV=production,例如NODE_ENV=production pnpm dev

  1. 打包编译
# 默认打包微信小程序
# 其它环境请参考 package.json 中的 scripts 脚本
pnpm build
  1. 上传发布
# 暂时只支持微信小程序上传
pnpm upload

bash 添加 auto complete

npm completion >> ~/.bashrc
npm completion >> ~/.zshrc

环境区分

使用环境变量API_URL来做开发测试以及线上环境的 api 地址区分,可以为不同环境设置不同的环境变量,已添加脚本up:testup:prod

错误告警监控

使用小程序自带的告警监控查看并加入告警群,可同时加入接口和业务告警群。

小程序开发事项

  • 支持多页签。如果不需要,可以删除src/assets/tabbar目录,并移除app.config.tstabBar的配置

  • API 请求封装。基于y2s实现,需要先在根目录的.y2src.js文件中配置好yapi的地址和token,然后执行pnpm update:api(更新同理)拉取所有api信息,调用时使用services['xxx']来使用。但是src/services/index.tsTODO处需要根据后端返回的数据结构做对应的修改。

  • 用户信息共享。修改src/app.tsx中所有TODO为实际业务接口,然后页面使用处使用useUserhook来获取和修改用户信息。如果业务不需要保存用户信息,可以删除src/app.tsx中用户相关代码,删除src/hooks/useUser.tssrc/types/user.ts文件。

  • 集成TaroUI。如果不需要使用,直接从代码中移除相关引用即可。

  • 新增页面。在src/pages目录中新建一个目录,复制src/pages/components/index.config.ts文件,新建页面的tsx(已添加项目级snippets,键入taro开始)和less文件,三者文件名保持一致,然后修改xxx.config.ts中的标题。

    最后在src/app.config.tspages添加相应的页面路径,如果是tabbar页面,还需要在tabbar.list中添加。

    建议一个目录下不要有超过 2 个子页面,如果子页面较多,建议每个子页面一个文件夹封装。

  • 新增组件。在src/components目录添加,一个组件一个目录,不需要xxx.config.ts文件,其它同页面新增一致。

  • 混合开发,在Taro里使用原生组件,参考

  • 下拉刷新

  • config 中配置说明

  • 更多微信小程序开发文档,请参考官方文档

  • 踩坑记录

  • 微信授权,openId,unionId,支付

About

小程序开发模板项目

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published