Skip to content

Commit

Permalink
chore: cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
haoziqaq committed Feb 27, 2024
1 parent 1524630 commit b25a751
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 266 deletions.
102 changes: 7 additions & 95 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,103 +1,15 @@
# varlet-app-template
# varlet-theme-builder

<span>English</span> |
<a href="https://github.com/varletjs/varlet-app-template/blob/main/README.zh-CN.md">中文</a>
<a href="https://github.com/varletjs/varlet-theme-builder/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`.
varlet-theme-builder is a theme builder for generating [varlet](https://github.com/varletjs/varlet-theme-builder) theme variables. Intelligently derive color matching that matches the design system through product theme colors or product images. The algorithm comes from [material-foundation](https://github.com/material-foundation/material-color-utilities)

### License
### Preview Address

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 `cypress` for e2e 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
```
https://varletjs.github.io/varlet-theme-builder

### Community

Expand All @@ -111,8 +23,8 @@ We recommend that `issue` be used for problem feedback, or others:

### 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 href="https://github.com/varletjs/varlet-theme-builder/graphs/contributors">
<img src="https://contrib.rocks/image?repo=varletjs/varlet-theme-builder" />
</a>

### Thanks to the following sponsors
Expand Down
100 changes: 6 additions & 94 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,103 +1,15 @@
# varlet-app-template
# varlet-theme-builder

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

### 介绍

varlet-app-template 是一个开箱即用的轻量化移动端 Web 模板,基于 `Vue3``Varlet``Vite``Typescript` 开发。

### 协议

本项目基于 `MIT` 协议

### 特性

- ⚡️ &nbsp; 基于 `Vue3``Varlet``Vite``Typescript` 开发
- 📦 &nbsp; 内置组件库和常用第三方库的自动引入和按需引入
- 🗂 &nbsp; 内置与原生应用类似的堆栈路由导航
- 🗂 &nbsp; 内置基于文件目录结构的约定式路由
- 🌍 &nbsp; 内置应用级国际化
- 📦 &nbsp; 内置请求库封装,拥抱 composition api
- 📦 &nbsp; 内置主题定制
- 📦 &nbsp; 内置移动端调试工具
- 📦 &nbsp; 内置 `pinia` 进行状态管理
- 📦 &nbsp; 内置 `mockjs` 进行数据 mock
- 📦 &nbsp; 内置 `vitest` 进行单元测试
- 📦 &nbsp; 内置 `cypress` 进行端到端测试
- 📦 &nbsp; 内置 `unocss` 集成
- 📦 &nbsp; 内置 `eslint``commitlint``lint-staged``prettier` 等代码检查/格式化工具
- 💪 &nbsp;`varletjs` 官方维护,第一方提供对 `varlet` 的支持
varlet-theme-builder 是一个用于生成 [varlet](https://github.com/varletjs/varlet-theme-builder) 主题变量的主题生成器。通过产品主题色或产品图片智能推导出符合设计系统的配色。算法来自 [material-foundation](https://github.com/material-foundation/material-color-utilities)

### 预览地址

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

### 安装使用

#### 获取项目

[通过该模板仓库创建一个你的仓库](https://github.com/varletjs/varlet-app-template/generate)


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

#### 安装依赖

```shell
pnpm install
```

#### 启动开发环境

```shell
pnpm dev
```

#### 构建打包

```shell
pnpm build
```

#### 预览

```shell
pnpm preview
```

#### 代码检查

```shell
pnpm lint
```

#### TS 类型检查

```shell
pnpm type-check
```

#### 代码格式化

```shell
pnpm format
```

#### 运行单元测试

```shell
pnpm test
```

#### 运行单元测试并生成测试报告

```shell
pnpm test:coverage
```
https://varletjs.github.io/varlet-theme-builder

### 反馈和交流

Expand All @@ -111,8 +23,8 @@ pnpm test:coverage

### 感谢贡献者们做出的努力

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

### 感谢以下赞助者
Expand Down
1 change: 0 additions & 1 deletion build/env.ts

This file was deleted.

26 changes: 0 additions & 26 deletions build/extendRoute.ts

This file was deleted.

8 changes: 0 additions & 8 deletions e2e/App.vue.spec.ts

This file was deleted.

9 changes: 0 additions & 9 deletions tests/components/AppBack.vue.spec.ts

This file was deleted.

9 changes: 0 additions & 9 deletions tests/components/__snapshots__/AppBack.vue.spec.ts.snap

This file was deleted.

16 changes: 0 additions & 16 deletions tests/setup.ts

This file was deleted.

11 changes: 3 additions & 8 deletions vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,10 @@ import unoCSS from 'unocss/vite'
import { fileURLToPath, URL } from 'node:url'
import { VarletImportResolver } from '@varlet/import-resolver'
import { defineConfig } from 'vitest/config'
import { isProduction } from './build/env'

// Use as needed
// import eruda from 'vite-plugin-eruda'
import { analyzer } from 'vite-bundle-analyzer'
// import { analyzer } from 'vite-bundle-analyzer'

export default defineConfig({
base: './',
Expand All @@ -32,10 +31,6 @@ export default defineConfig({
target: ['ios12']
},

esbuild: {
drop: isProduction() ? ['console', 'debugger'] : []
},

test: {
environment: 'jsdom',
coverage: {
Expand Down Expand Up @@ -84,9 +79,9 @@ export default defineConfig({

progress(),

unoCSS(),
unoCSS()

analyzer()
// analyzer()
// eruda()
]
})

0 comments on commit b25a751

Please sign in to comment.