Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 1019 Bytes

CONTRIBUTING.md

File metadata and controls

49 lines (30 loc) · 1019 Bytes
Raw

First of all. Thanks for contributing Flutter Vant UI!

This Project contains VantUI (core), Icons, Docs. For managing them we use pnpm.

Prerequisites

  • Flutter 3.3.10
  • Dart 2.18.6
  • Pnpm (npm -g i pnpm)

Use fvm for version managing is strongly recommended.

Install Dependencies

Install dependencies for docs project:

pnpm i

And also needs to install pubs for flutter projects:

pnpm run pub

Run Android demo

Connect an Android phone via adb. Or launch an AVD device.

Then:

pnpm dev:android

Run Docs

pnpm dev

After ensuring both Android and Docs don't have any problems, it is welcome to open a pull request.

FAQ

Q: Why not use melos for monorepo managing?

A: Melos is a good at monorepo tooling, that my team has used for over 1 years. However, it may have some bugs in recent versions that NOT be friendly for newbies. The pnpm will be temporary used until Melos#511 is fixed.