Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/didilinkin/elf-taro
Taro 小程序 脚手架 (Taro 3 + Dva + Typescript + Immer) - 内置 Redux 计数器, 异步数据请求 与 腾讯小程序地图 demo
https://github.com/didilinkin/elf-taro
cz-customizable dvajs immer lodash taro taro-ui tencent-map-sdk typescript wechat-mini-program
Last synced: about 1 month ago
JSON representation
Taro 小程序 脚手架 (Taro 3 + Dva + Typescript + Immer) - 内置 Redux 计数器, 异步数据请求 与 腾讯小程序地图 demo
- Host: GitHub
- URL: https://github.com/didilinkin/elf-taro
- Owner: didilinkin
- License: mit
- Created: 2019-01-27T11:00:38.000Z (almost 6 years ago)
- Default Branch: 2.x
- Last Pushed: 2023-03-27T10:18:13.000Z (over 1 year ago)
- Last Synced: 2024-05-22T01:13:10.118Z (7 months ago)
- Topics: cz-customizable, dvajs, immer, lodash, taro, taro-ui, tencent-map-sdk, typescript, wechat-mini-program
- Language: TypeScript
- Homepage:
- Size: 2.42 MB
- Stars: 66
- Watchers: 4
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-taro - Taro 示例项目(DVA计数器 | 异步请求 | 腾讯地图): Taro+Dva+Typescript+Immer
README
# elf-taro
Elf 基于 Taro 的 小程序 脚手架
## 必要依赖
> 不要轻易升级 `package.json`内的依赖
* ### Node
version: v14.14.0, 通过 `nvm`更改 Node 版本:
```bash
nvm install 14.14.0 # 安装 v14.14.0
nvm use 14.14.0 # 切换为 v14.14.0
node -v # 查看 切换是否成功
# => v14.14.0
```
* ### Yarn
version: v1.22.19
请务必使用 `Yarn` 安装依赖! 不要使用 其他安装工具, 有几率报错
本项目使用的 源: `https://registry.yarnpkg.com/`
未使用 taobao源, 推荐 `nrm`工具切换源
* ### taro-cli
version: v3.0.0-rc.6, 需要将工具切换版本
```bash
yarn global add @tarojs/[email protected]
taro -v # 查看 切换是否成功
# => 3.0.0-rc.6
```
## 主要功能
- dva
- 异步请求
- 腾讯地图 示例
- Typescript
## 预览项目
```bash
# 全局安装taro脚手架
npm install -g @tarojs/cli
# 安装依赖
yarn install
# 小程序 预览模式 => 用 小程序开发工具 打开 ./dist 文件夹 即可预览
yarn dev:weapp
```
## 打包项目
```bash
# 打包完成的小程序 文件在 ./dist 文件夹内
yarn build:weapp
```
## 注意事项
- 本项目拉取到本地后， “小程序开发工具” 请打开 “不校验合法域名”！ 方便查看 请求效果
## 常见错误
1. 开发环境版本不相同
[Taro 版本升级权威指南](https://aotu.io/notes/2020/08/31/taro-versions/index.html)
[taro update self 的更新好像不管用](https://github.com/NervJS/taro/issues/297)
# 目录结构
├── dist/ // 微信小程序编译结果目录
├── config/ // Taro 配置目录
│ ├── dev.js // 开发时配置
│ ├── index.js // 默认配置
│ └── prod.js // 打包时配置
├── src/ // 源码目录
│ ├── components/ // 公共组件
│ └── dvaCore/ // dva-core 配置
│ └── index.ts
│ └── models/ // 全局 models
│ └── index.ts
│ ├── pages // 页面文件目录
│ │ └── index
│ │ ├── model/ // 业务逻辑 (Dva model)
│ │ ├── index.tsx // 页面逻辑
│ │ └── index.styl // 页面样式
│ ├── services/ // 全局模块请求
│ ├── utils // 常用工具类
│ ├── app.js // 入口文件
│ └── index.html
├── global.d.ts // 全局类型配置
└── package.json // 项目依赖
## TODO
- 用户信息读取
- components 功能
- dva-model-extend
## 已配置的依赖
| 名称 | 库名称 | 用途 |
| ------- | ------------------------------------------------------------------------ | ------------------------------------- |
| Taro | [@tarojs/taro](https://taro-docs.jd.com/taro/docs/README/index.html) | 基础库 |
| Taro-UI | [taro-ui](https://taro-ui.jd.com/#/docs/introduction) | 样式库 |
| Dva | [dva-core](https://dvajs.com/guide/) | 基于 redux 和 redux-saga 的数据流方案 |
| Immer | [dva-immer](https://github.com/dvajs/dva/tree/master/packages/dva-immer) | immer 不可变结构 |
| Lodash | [lodash](https://lodash.com/docs/4.17.15) | 函数库 |
## 开发环境的依赖
| 名称 | 库名称 | 用途 |
| --------------- | ---------------------------------------------------------------- | ----------------- |
| Typescript | [typescript](https://www.typescriptlang.org/docs) | JS 超集语言 |
| ESLint | [eslint](https://eslint.org/docs/user-guide/getting-started) | 规范检查 |
| Prettier | [prettier](https://prettier.io/docs/en/index.html) | 代码格式化 |
| cz-customizable | [cz-customizable](https://www.npmjs.com/package/cz-customizable) | Git commit 规范化 |
## 特别鸣谢
| 库名称 | 用途 |
| -------------------------------------------------------- | ------------------------------------------------------- |
| [taro-request](https://github.com/TigerHee/taro-request) | 封装 Taro.request（拦截器，url 配置，Authorization 等） |