Skip to content

Commit 5d3c042

Browse files
authored
Update README.md
1 parent 33edfc7 commit 5d3c042

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@
33
# Vue-webpack-typescript project starter
44

55
This project is generated via [vue-webpack-minimal](https://github.com/akoidan/vue-webpack-typescript) and features:
6-
- Project CRUD skeleton [vue.pychat.org](https://vue.pychat.org)
7-
- typescript loading with babel with typechecking in a parallel thread. Everything (vuex, cypress, vue-data) is type safe!
8-
- vue with vuetify, vuex, router, sass, vuex-module-decorators, vue-property-decorator support typescript
9-
- cypress with code-coverage support, unit test support, screenshot assert and typescript support.
10-
- lint: a compilation of very strict lint rules for everything: vue, styles (sass), typescript that don't conflict with each other.
11-
- base example of CRUD pages with written api classes, tests and predefined structure
6+
- Base example of CRUD pages with written api classes, tests and predefined [vue.pychat.org](https://vue.pychat.org)
7+
- Typescript loading with babel with typechecking in a parallel thread. Everything (vuex, cypress, vue-data) is type safe!
8+
- Vue with vuetify, vuex, router, sass, vuex-module-decorators, vue-property-decorator support typescript
9+
- Cypress with code-coverage support, unit test support, screenshot assert and typescript support.
10+
- Lint: a compilation of very strict lint rules for everything: vue, styles (sass), typescript that don't conflict with each other.
1211

1312
## Vue3 status
1413

@@ -17,7 +16,7 @@ Atm 09/2020, vue3 is released as stable version 3.0.0, but the ecosystem around
1716
## Get started
1817

1918
### Install dependencies:
20-
- `yarn install --frozen-lockfile`
19+
- `yarn install --frozen-lockfile`. You can fall back to `npm` if you still use it.
2120
- [OPTIONAL] If compilation above crashes on binaries, do `nvm use`. In total you need [yarn](https://classic.yarnpkg.com/en/docs/install/) and [nvm](https://github.com/nvm-sh/nvm)
2221

2322
### Run development server
@@ -43,19 +42,19 @@ The command bellow builds static files with coverage babel plugin information, c
4342
yarn test
4443
```
4544

46-
You can check reports in `.nyc` directory, including coverage information.
45+
You can check reports in `nyc` directory, including coverage information.
4746

4847
#### Headful cypress upon webpack-dev-server
4948

50-
This command is useful during development. You can click and inspect in live mode in cypress, and just develop while you're tests are ran automatically on file save somewhere. I usually have cypress test on one display, IDE on another one, and browser on 3rd one. So I instantly see what changes my code introduces.
49+
This command is useful during development. You can click and inspect in live mode in cypress, and just develop while your tests are being ran automatically on file save. I usually have cypress test on one display, IDE on another one, and browser on 3rd one. So I instantly see which changes my code introduces.
5150

5251
1. Start dev-server in test mode. `yarn start` won't work, cause of missing coverage info and some other polyfills and tweaks required.
5352

5453
```bash
5554
yarn start:test
5655
```
5756

58-
2. Open cypress debug mode. This mode means you can inspect the cypress UI directly in browser and your test could automatically run upon file save.
57+
2. Open cypress in debug mode. This mode means you can inspect the cypress UI directly in the browser and your test could automatically run upon file save.
5958

6059
```bash
6160
yarn run test:cypress:debug
@@ -80,12 +79,11 @@ yarn run build:prod
8079

8180
### Environment variables
8281

83-
- `APP_TEST` - adds required code for testing to output files when set to True (istanbul coverage, XHR polyfill for cypress)
84-
- `APP_API_URL` - public http api url e.g. <https://jsonplaceholder.typicode.com>
85-
- `APP_PUBLIC_PATH` - specifies public url for images/js/css/fonts instead of relative path like './main.js
86-
- `APP_VERSION` - git version
87-
- `APP_FILE_MODE` - sets, whether static files should be built for file mode (dragging index.html to browser) or not.
88-
That turns off history mode in browser and removes crossOriginLoading links
82+
- `APP_TEST` - `true`/`false`, adds required code for testing to output files when set to True (istanbul coverage, XHR polyfill for cypress)
83+
- `APP_API_URL` - url e.g. `https://jsonplaceholder.typicode.com`, public http API url
84+
- `APP_PUBLIC_PATH` - string, e.g. `https://s3.amazonaws.com/`, url for images/js/css/fonts instead of relative path like './main.js. Can be used if you're using CDN that's on a different domain than `index.html`
85+
- `APP_VERSION` - string, e.g. `build-v378`, some unique string which identifies your souce code. I usually pass git version or git tag to this variable in Continuous Integration.
86+
- `APP_FILE_MODE` - `true`/`false`, sets whether static files should be built for file mode (dragging index.html to browser) or not. By setting to true, this turns off [history mode](https://router.vuejs.org/guide/essentials/history-mode.html#html5-history-mode) in browser and removes crossOriginLoading links.
8987

9088
### Configuration files
9189

0 commit comments

Comments
 (0)