Skip to content

Commit be26a7e

Browse files
author
Günter Schafranek
committed
docs: Updated docs
1 parent 3674e83 commit be26a7e

File tree

1 file changed

+28
-12
lines changed

1 file changed

+28
-12
lines changed

README.md

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# parcel-vue-typescript boilerplate project 📦
2+
23
Boilerplate for Vue.js & Typescript, base on Parcel bundler, copied from [masonz/parcel-vue-ts](https://github.com/masonz/parcel-vue-ts) template and modified (updated dependencies, dropped parcle-plugin-vue, since it is natively supported now).
34

45
## What's inside? 🗃
6+
57
* [Vue3](https://github.com/vuejs/vue)
68
* [Vue-Router](https://github.com/vuejs/vue-router)
79
* [Vuex](https://github.com/vuejs/vuex)
@@ -10,33 +12,47 @@ Boilerplate for Vue.js & Typescript, base on Parcel bundler, copied from [masonz
1012
* [Parcel bundler](https://github.com/parcel-bundler/parcel)
1113

1214
### For class based components use
13-
* [Vue Class Setup](https://github.com/fmfe/vue-class-setup)
14-
* [Vue Facing Decotrator](https://github.com/facing-dev/vue-facing-decorator)
15+
16+
* [Vue Facing Decorator](https://github.com/facing-dev/vue-facing-decorator)
17+
* [vuex-facing-decorator](https://github.com/wangzhiguoengineer/vuex-facing-decorator)
18+
19+
## Prerequisites 📋
20+
21+
* [Node.js](https://nodejs.org/en/) (>= 18.8.0)
22+
* [pnpm](https://pnpm.js.org/en/installation) (>= 5.0.0)
23+
24+
Both are managed within the project's package.json using [volta](https://volta.sh).
1525

1626
## Getting Started 🚀
27+
1728
Clone this repository, and run npm/yarn install.
18-
```
29+
30+
```shell
1931
git clone [email protected]:gschafra/parcel-vue-typescript-boilerplate.git
2032
cd parcel-vue-ts
21-
npm/yarn install
33+
pnpm install --shamefully-hoist
2234
```
2335

2436
### Development
37+
38+
```shell
39+
pnpm run dev
2540
```
26-
npm/yarn run dev
27-
```
41+
2842
Parcel has a development server built in, which will automatically rebuild your app as you change files and supports hot module replacement for fast development.
2943

3044
### Production
45+
46+
```shell
47+
pnpm run build
3148
```
32-
npm/yarn run build
33-
```
49+
3450
When you build production, parcel defaults to enable miniatation.
3551

3652
### Unit tests
37-
```
38-
npm/yarn run test:unit
39-
```
40-
Unit test the code using jest,and you can run through ` npm run test:coverage ` to get the test coverage.
4153

54+
```shell
55+
phpm run test:unit
56+
```
4257

58+
Unit test the code using jest,and you can run through `pnpm run test:coverage ` to get the test coverage.

0 commit comments

Comments
 (0)