|
| 1 | +# CLI & Templates |
| 2 | + |
| 3 | +Through this section, you can learn how to use the [create-uni](https://github.com/uni-helper/create-uni) CLI to quickly create a `uni-app` project integrated with `Wot UI`, as well as many quick-start projects that have already integrated `Wot UI`. |
| 4 | + |
| 5 | +## CLI |
| 6 | + |
| 7 | +We recommend using [create-uni](https://github.com/uni-helper/create-uni) to create projects, which supports one-click creation of basic projects integrated with Wot UI. Use the following command: |
| 8 | + |
| 9 | +```bash |
| 10 | +pnpm create uni <your-project-name> --ts -m pinia -u wot -e |
| 11 | +``` |
| 12 | + |
| 13 | +This will complete the following tasks: |
| 14 | + |
| 15 | +- Create a TypeScript project |
| 16 | +- Integrate Pinia state management |
| 17 | +- Automatically configure WotUI component library |
| 18 | +- Add ESLint support |
| 19 | + |
| 20 | +For more information, please refer to [create-uni](https://github.com/uni-helper/create-uni). |
| 21 | + |
| 22 | +## Templates |
| 23 | + |
| 24 | +There are many excellent templates that have chosen Wot UI as their base component library. We've selected 3 templates to introduce here, and you can compare and choose for yourself. |
| 25 | + |
| 26 | +### wot-demo |
| 27 | + |
| 28 | +🍀 [wot-demo](https://github.com/Moonofweisheng/wot-demo) is a `uni-app` quick-start project based on [vitesse-uni-app](https://github.com/uni-helper/vitesse-uni-app) with deep integration of the `Wot UI` component library. It's maintained by the `Wot UI` team, saying goodbye to `HBuilderX` and embracing modern frontend development toolchains. If you're a loyal user of `Wot UI`, this template is perfect for you. |
| 29 | + |
| 30 | +You can also combine it with the CLI section [create-uni](https://github.com/uni-helper/create-uni) to create a project. Open the terminal and use the following command: |
| 31 | + |
| 32 | +```bash |
| 33 | +pnpm create uni <project-name> -t wot-demo |
| 34 | +``` |
| 35 | + |
| 36 | +Open the project folder in VS Code: |
| 37 | + |
| 38 | +```bash |
| 39 | +code <project-name> |
| 40 | +``` |
| 41 | + |
| 42 | +Install dependencies: |
| 43 | + |
| 44 | +```bash |
| 45 | +pnpm install |
| 46 | +``` |
| 47 | + |
| 48 | +Run the project: |
| 49 | + |
| 50 | +```bash |
| 51 | +pnpm dev |
| 52 | +``` |
| 53 | + |
| 54 | +### vitesse-uni-app |
| 55 | + |
| 56 | +[vitesse-uni-app](https://github.com/uni-helper/vitesse-uni-app) is a cross-platform quick-start template powered by `Vite & uni-app`, backed by the `Uni Helper` team, saying goodbye to `HBuilderX` and embracing modern frontend development. Although it doesn't have deep integration with the Wot UI component library, it's an excellent clean template worth recommending. |
| 57 | + |
| 58 | +### unibest |
| 59 | + |
| 60 | +[unibest](https://github.com/unibest-tech/unibest) uses the latest frontend technology stack and doesn't need to rely on `HBuilderX`. It runs through command line, with `VSCode` as the recommended editor (or `webstorm`). It has built-in extensive basic functionality and provides numerous auxiliary features, giving you the `best` experience when writing `uniapp`, with optional `Wot UI` support. |
| 61 | + |
| 62 | +### More Templates |
| 63 | + |
| 64 | +Of course, there are more templates for you to choose from. You can compare and select a template you like from the following list. |
| 65 | + |
| 66 | +If you're developing a `uni-app` template integrated with `Wot UI`, you can send an email to `1780903673@qq.com` to contact me, and I'll add your template to this list as soon as possible. |
| 67 | + |
| 68 | +| Template | Stars | Description | |
| 69 | +|----------|-------|-------------| |
| 70 | +| [wot-demo](https://github.com/Moonofweisheng/wot-demo) |  | 🍀 A uni-app quick-start project based on vitesse-uni-app with deep integration of Wot UI component library, maintained by the `Wot UI` team, saying goodbye to `HBuilderX` and embracing modern frontend development toolchains. | |
| 71 | +| [vitesse-uni-app](https://github.com/uni-helper/vitesse-uni-app) |  | A cross-platform quick-start template powered by Vite & uni-app, backed by the Uni Helper team, saying goodbye to HBuilderX and embracing modern frontend development. | |
| 72 | +| [unibest](https://github.com/unibest-tech/unibest) |  | Uses the latest frontend technology stack, doesn't need to rely on `HBuilderX`, runs through command line, with built-in extensive basic functionality and auxiliary features, giving you the `best` experience when writing `uniapp`. | |
| 73 | +| [vite-uniapp-template](https://github.com/viarotel-org/vite-uniapp-template) |  | A practical-first uni-app starter template. | |
| 74 | +| [uni-plus](https://github.com/DaMaiCoding/uni-plus) |  | A "super super super" useful uniapp development template. | |
| 75 | +| [uniez-template](https://github.com/zhe-qi/uniez-template) |  | A uniapp template that prioritizes "functionality" and "development experience". | |
| 76 | +| [snail-uni](https://github.com/hu-snail/snail-uni) |  | A UniApp framework template built specifically for developers. | |
0 commit comments