Skip to content

Commit 26adea4

Browse files
committed
docs: add readme
1 parent de0d956 commit 26adea4

File tree

2 files changed

+60
-0
lines changed

2 files changed

+60
-0
lines changed

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# vite-template-starter
2+
3+
A vite-based front-end startup template generator.
4+
5+
![create-app](./preview.png)
6+
7+
## Usage
8+
9+
To create a new project using vite-template-starter, simply run the following command in your terminal:
10+
11+
```shell
12+
npx vite-template-starter@latest
13+
```
14+
15+
> [!NOTE]
16+
> (`@latest` or `@legacy`) MUST NOT be omitted, otherwise `npm` may resolve to a cached and outdated version of the package.
17+
18+
## Step
19+
20+
- Step1 Select your language.
21+
22+
```text
23+
√ Select your language:
24+
> EN
25+
> 中文
26+
```
27+
28+
- Step2 Select dependency to add the project.
29+
30+
```text
31+
√ Project name: >> vite-starter
32+
√ Select your packageManager:
33+
> npm
34+
> yarn
35+
> pnpm
36+
√ Select a framework:
37+
> vue
38+
> react
39+
√ Add JSX Support? ... off / on
40+
√ Add Vue Router for Single Page Application development? ... off / on
41+
√ Add Pinia for state management? ... off / on
42+
√ Add ESLint for code quality? ... off / on
43+
√ Add Prettier for code formatting? ... off / on
44+
√ Add Husky for git hooks? ... off / on
45+
```
46+
47+
- Step3 Select vite plugin.
48+
49+
```text
50+
√ Select custom plugins:
51+
( ) @vueuse/core
52+
( ) rollup-plugin-visualizer
53+
( ) unplugin-auto-import
54+
( ) unplugin-vue-components
55+
( ) vite-plugin-compression
56+
( ) vite-plugin-external-cdn
57+
( ) vite-plugin-html
58+
( ) vite-plugin-image-optimizer
59+
( ) vite-svg-loader
60+
```

preview.png

70.7 KB
Loading

0 commit comments

Comments
 (0)