# varlet-app-template

**Repository Path**: william0598/varlet-app-template

## Basic Information

- **Project Name**: varlet-app-template
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2023-10-24
- **Last Updated**: 2023-12-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# varlet-app-template

<span>English</span> |
<a href="https://github.com/varletjs/varlet-app-template/blob/main/README.zh-CN.md">中文</a>

### Intro

varlet-app-template is an out-of-the-box lightweight mobile web template, developed based on `Vue3`, `Varlet`, `Vite`, `Typescript`.

### License

This project is based on the `MIT` license

### Features

- ⚡️ &nbsp; Developed based on `Vue3`, `Varlet`, `Vite`, `Typescript`
- 📦 &nbsp; Automatic and on-demand import of built-in component libraries and third-party libraries
- 🗂 &nbsp; Built-in stack routing navigation similar to native apps
- 🗂 &nbsp; Built-in conventional routing based on file directory structure
- 🌍 &nbsp; Built-in application-level internationalization
- 📦 &nbsp; Built-in request library integrated, support composition api
- 📦 &nbsp; Built-in theme customization
- 📦 &nbsp; Built-in mobile debugging tool
- 📦 &nbsp; Built-in `pinia` for state management
- 📦 &nbsp; Built-in `mockjs` for data mocking
- 📦 &nbsp; Built-in `vitest` for unit testing
- 📦 &nbsp; Built-in `unocss` integration
- 📦 &nbsp; Built-in `eslint`, `commitlint`, `lint-staged`, `prettier` and other code checking/formatting tools
- 💪 &nbsp; Officially maintained by `varletjs`, the first party provides support for `varlet`

### Page Preview Address

https://varletjs.github.io/varlet-app-template

### Install And Use

#### Get Project

[Create a repository from this template repository](https://github.com/varletjs/varlet-app-template/generate)

or

```shell
git clone https://github.com/varletjs/varlet-app-template.git
```

#### Install Dependencies

```shell
pnpm install
```

#### Start the development environment

```shell
pnpm dev
```

#### Build

```shell
pnpm build
```

#### Preview

```shell
pnpm preview
```

#### Lint Code

```shell
pnpm lint
```

#### TS type checking

```shell
pnpm type-check
```

#### Code Formatting

```shell
pnpm format
```

#### Running unit tests

```shell
pnpm test
```

#### Run unit tests and generate test reports

```shell
pnpm test:coverage
```

### Community

We recommend that [issue](https://github.com/varletjs/varlet/issues) be used for problem feedback, or others:

* Wechat group 

<img style="width: 25%" src="https://cdn.jsdelivr.net/gh/varletjs/varlet-static/community.png" />

* Join the [Discord](https://discord.gg/Dmb8ydBHkw)

### Thanks to contributors

<a href="https://github.com/varletjs/varlet-app-template/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=varletjs/varlet-app-template" />
</a>

### Thanks to the following sponsors

<a href="https://cdn.jsdelivr.net/gh/varletjs/varlet-static/sponsorkit/sponsors.svg">
  <img src="https://cdn.jsdelivr.net/gh/varletjs/varlet-static/sponsorkit/sponsors.svg">
</a>

### Sponsor this project

Sponsor this project to support our better creation. It is recommended to use afdian to subscribe, and your avatar will appear in this project.

#### Afdian

<a href="https://afdian.net/a/haoziqaq">https://afdian.net/a/haoziqaq</a>

#### Wechat / Alipay

<img style="width: 25%" src="https://cdn.jsdelivr.net/gh/varletjs/varlet-static/wechat.jpg" />
<img style="width: 25%" src="https://cdn.jsdelivr.net/gh/varletjs/varlet-static/alipay.jpg" />