Skip to content

Commit a115151

Browse files
KocalAkryum
authored andcommitted
docs(cli-ui): add more notes for local development (vuejs#2281)
* docs(cli-ui): add some more user-friendly notes * docs(cli-ui): add notes about running E2E tests locally * chore(docs:cli-ui): cr/wording * chore(docs:cli-ui): revert some changes, remove additionnal command for tests * chore(docs:cli-ui): commands for cli-ui-addon-wepack
1 parent bf91533 commit a115151

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

packages/@vue/cli-ui/README.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,38 @@
11
# @vue/cli-ui
22

3-
Start development version:
3+
### Local development
4+
5+
Before starting a local cli-ui instance,
6+
consider following the [contributing guide](https://github.com/vuejs/vue-cli/blob/dev/.github/CONTRIBUTING.md)
7+
in order to download all required dependencies of vue-cli's packages.
8+
9+
Just after, you should build once then serve `@vue/cli-ui-addon-webpack` by running:
10+
```bash
11+
cd ../cli-ui-addon-webpack
12+
yarn build # just do once
13+
yarn serve
14+
```
15+
16+
Then you start the ui server (based on Apollo):
17+
18+
```
19+
cd ../cli-ui
20+
yarn run apollo
21+
```
22+
23+
And then in another terminal, you should serve the ui web app:
424

525
```
626
yarn run serve
727
```
828

9-
In another terminal:
29+
#### Testing
30+
31+
For running E2E tests, you just need to run:
1032

1133
```
12-
yarn run apollo
34+
yarn run test:e2e
1335
```
1436

15-
You also need to build `@vue/cli-ui-addon-webpack`.
37+
This will open a new [Cypress](https://www.cypress.io/) window.
38+
You can now run all or specific integration tests.

0 commit comments

Comments
 (0)