taro README

The project's README from github.com/NervJS/taro. As one markdown file: README.md.

Taro

开放式跨端跨框架解决方案,轻松构建可以运行在 小程序/Web/APP 上的应用

PRs Welcome GitHub contributors GitHub commit activity GitHub closed issues GitHub commits since latest release (by date) GitHub Release Date

简体中文 | English

👽 Taro['tɑ:roʊ],泰罗·奥特曼,宇宙警备队总教官,实力最强的奥特曼。

目录

  1. 简介
  2. 学习资源
  3. 社区共享
  4. 项目状态
  5. 使用案例
  6. 加入共建
  7. 问题反馈与建议
  8. 特别鸣谢
  9. 贡献者们
  10. 开发计划
  11. 更新日志
  12. 开发交流

简介

开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。现如今市面上端的形态多种多样,Web、React Native、微信小程序等各种端大行其道,当业务要求同时在不同的端都要求有所表现的时候,针对不同的端去编写多套代码的成本显然非常高,这时候只编写一套代码就能够适配到多端的能力就显得极为需要

版本迁移

Taro 1/2 迁移至 Taro 3,请阅读《Taro 版本升级权威指南》

学习资源

5 分钟上手 Taro 开发

awesome-taro

社区共享

Taro 物料市场——让每一个轮子产生价值

UI 库

名称 地址 介绍 支持的框架 支持的 Taro 版本
taro-ui https://taro-ui.jd.com/#/ 一套基于 Taro 框架开发的多端 UI 组件库 React Taro 1/2/3
NutUI https://nutui.jd.com/#/ 京东风格的轻量级移动端 Vue 组件库 Vue3 Taro 3
taroify https://taroify.github.io/taroify.com/introduce/ 轻量、可靠的小程序端 Taro 组件库(Vant 的 Taro 版本) React Taro 3
@antmjs/vantui https://antmjs.github.io/vantui/#/home 基于有赞 VantWeapp 开发的同时支持 Taro 和 React 的 UI 库 React Taro 3
Tard https://tard-ui.selling.cn/ 一套基于 Taro 框架开发的多端 React UI 组件库 React Taro 3
duxui https://duxapp.cn/docs/duxui/start/ 一套能同时兼容小程序、React Native、鸿蒙、H5的移动端ui组件库 React Taro 4

项目状态

Alt

使用案例

Taro 已经投入了我们的生产环境中使用,业界也在广泛地使用 Taro 开发多端应用。

征集更多优秀案例

加入共建

加入 Taro 社区共建倡议

Taro 邀你加入社区共建

为 Taro 贡献代码

Taro 非常欢迎社区开发者为 Taro 贡献代码,在贡献之前请先阅读贡献指南。

如果你想为 Taro 实现一个重要功能,需要先撰写 RFC 文档,按照 Taro 的RFC 机制进行操作,在经过社区讨论完善后才可以进行代码的提交。

问题反馈与建议

给 Taro 提 ISSUE

强烈推荐阅读 《提问的智慧》、《如何向开源社区提问题》 和 《如何有效地报告 Bug》、《如何向开源项目提交无法解答的问题》,更好的问题更容易获得帮助。

Let's fund issues in this repository

特别鸣谢

nanjingboy jsNewbee Qiyu8 Garfield550
nanjingboy jsNewbee Qiyu8 Garfield Lee

贡献者们

开发计划

Milestones

更新日志

本项目遵从 Angular Style Commit Message Conventions,更新日志请查阅 Release。

开发交流

官方交流微信群

License

MIT License

Copyright (c) O2Team

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

taro (NervJS/taro)

Searching Database…

37.7K ·GitHub
What is this?Taro is an open cross-platform, cross-framework solution: write one codebase with React, Vue or Nerv and it runs as WeChat/JD/Baidu/Alipay/ByteDance/QQ mini-programs, H5 web apps, or React Native apps for iOS and Android.
Is this a framework I add to a project, or something else?A full framework with its own build toolchain, not a single library: a TypeScript monorepo that compiles one source tree to each target platform, with parts of the compiler written in Rust.
How do I start building with it?Follow the 'get started in 5 minutes' quickstart linked in the README: install the Taro CLI globally via npm, scaffold a project, and build for the platform you need; docs are at docs.taro.zone.
What do I need to have before using it?A Node.js environment plus working knowledge of React, Vue or Nerv — a Taro app is ordinary components from those frameworks compiled to each target.
What's the catch — anything painful about versions or upgrades?Major upgrades are the main gotcha: there's an official guide for migrating Taro 1/2 projects to Taro 3, and parts of the ecosystem already target Taro 4, so match UI kit versions to your Taro version.
Who is this actually for?Front-end teams that need the same product across several mini-program platforms, the web and native mobile — the README notes Taro already runs in production there and across the industry.
Are there ready-made UI component libraries for Taro?Yes — the README's community table lists taro-ui (React, Taro 1/2/3), NutUI (JD-style, Vue 3), taroify (a Taro port of Vant), @antmjs/vantui, Tard and duxui, covering React and Vue 3 across Taro versions.
Why write one Taro codebase instead of a separate app per platform?Because maintaining a separate codebase for every end is expensive. The README's pitch: when a business must appear on many ends, a single codebase that adapts to all of them is what's really needed — that's the problem Taro solves.
What is Nerv, one of the supported frameworks?A lightweight React-compatible component library from NervJS, the same organization behind Taro — the README lists it alongside React and Vue as a framework you can write your app in.
Why is it called Taro?After Ultraman Taro: the README introduces the project with a joke that Taro is the chief instructor of the Universe Guard and the strongest of the Ultramen, pronounced ['tɑ:roʊ].
Creator
NervJS
Size
1.5 GB
Stars
37.7K
Age
8y
Commits · 90 Days