Mercurial > gemma

annotate client/README.md @ 167:a6d7ee20fc96

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: Adding documentation on how to run tests Documentation added for running unit or e2e tests
author Thomas Junk <thomas.junk@intevation.de>
date Fri, 06 Jul 2018 12:09:08 +0200
parents a719a3ba2fb4
children e4e4a0e6338e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
1 N.N
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
2 ===
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
3
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
4 * Install dependencies
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
5
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
6 * Javascript
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
7
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
8 `yarn install`
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
9
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
10 * Configuration via `.env`-file
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
11
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
12 **Example** given via `.env.sample`
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
13
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
14 ```
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
15 cp .env.sample .env
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
16 ````
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
17
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
18 * Start Development servers
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
19
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
20 * Javascript
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
21
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
22 Run webpack-dev-server with `yarn serve`
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
23
121
9a5bbe9c593c Split README into client and toplevel.
Bernhard Reiter <bernhard@intevation.de>
parents: 13
diff changeset
24 * If you also want to start the backend, try
8
d97a8842c985 start front and back both concurrently
Thomas Junk <thomas.junk@intevation.de>
parents: 3
diff changeset
25
d97a8842c985 start front and back both concurrently
Thomas Junk <thomas.junk@intevation.de>
parents: 3
diff changeset
26 `yarn run:both`
d97a8842c985 start front and back both concurrently
Thomas Junk <thomas.junk@intevation.de>
parents: 3
diff changeset
27
3
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
28 * Build `yarn build`
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
29
1597506a2241 merge with vue-cli
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
30 builds the production ready assets to `web` folder.
152
a719a3ba2fb4 Client README updated for translations
Thomas Junk <thomas.junk@intevation.de>
parents: 121
diff changeset
31
a719a3ba2fb4 Client README updated for translations
Thomas Junk <thomas.junk@intevation.de>
parents: 121
diff changeset
32 * Translation
a719a3ba2fb4 Client README updated for translations
Thomas Junk <thomas.junk@intevation.de>
parents: 121
diff changeset
33 * Extract Messages via `make makemessages`
a719a3ba2fb4 Client README updated for translations
Thomas Junk <thomas.junk@intevation.de>
parents: 121
diff changeset
34 * Translations are converted via `make translations`
167
a6d7ee20fc96 docs: Adding documentation on how to run tests
Thomas Junk <thomas.junk@intevation.de>
parents: 152
diff changeset
35
a6d7ee20fc96 docs: Adding documentation on how to run tests
Thomas Junk <thomas.junk@intevation.de>
parents: 152
diff changeset
36 * Tests
a6d7ee20fc96 docs: Adding documentation on how to run tests
Thomas Junk <thomas.junk@intevation.de>
parents: 152
diff changeset
37 * Unit tests are started via `yarn test:unit`
a6d7ee20fc96 docs: Adding documentation on how to run tests
Thomas Junk <thomas.junk@intevation.de>
parents: 152
diff changeset
38 * e2e tests are started via `yarn test:e2e`
a6d7ee20fc96 docs: Adding documentation on how to run tests
Thomas Junk <thomas.junk@intevation.de>
parents: 152
diff changeset
39
a6d7ee20fc96 docs: Adding documentation on how to run tests
Thomas Junk <thomas.junk@intevation.de>
parents: 152
diff changeset
40 Vue cli supports the Chrome selenium driver out of the box
a6d7ee20fc96 docs: Adding documentation on how to run tests
Thomas Junk <thomas.junk@intevation.de>
parents: 152
diff changeset
41 If you are interested in using the Firefox variant of the driver
a6d7ee20fc96 docs: Adding documentation on how to run tests
Thomas Junk <thomas.junk@intevation.de>
parents: 152
diff changeset
42 see [Vue CLI Plugin Docs](https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-e2e-nightwatch)
a6d7ee20fc96 docs: Adding documentation on how to run tests
Thomas Junk <thomas.junk@intevation.de>
parents: 152
diff changeset
43 and see also [Nightwatch documentation](http://nightwatchjs.org/gettingstarted#geckodriver)
a6d7ee20fc96 docs: Adding documentation on how to run tests
Thomas Junk <thomas.junk@intevation.de>
parents: 152
diff changeset
44