Mercurial > gemma
annotate client/README.md @ 3526:c71f1b15c5d9 import_review
default show details
author | Thomas Junk <thomas.junk@intevation.de> |
---|---|
date | Wed, 29 May 2019 15:42:32 +0200 |
parents | 72d6fcb2147d |
children | b5619087e3e9 |
rev | line source |
---|---|
3 | 1 * Install dependencies |
2 | |
1802
70573eea890e
improve Translation process : improve package.json and update the documentation
Fadi Abbud <fadi.abbud@intevation.de>
parents:
1009
diff
changeset
|
3 * Install (`xgettext`) tool (e.g. for Debian xgettext (GNU gettext-tools) 0.19.8.1) |
70573eea890e
improve Translation process : improve package.json and update the documentation
Fadi Abbud <fadi.abbud@intevation.de>
parents:
1009
diff
changeset
|
4 |
3 | 5 * Javascript |
6 | |
7 `yarn install` | |
8 | |
499
5b7a4327f6c0
Recommend using .env.local instead of copying .env.sample
Tom Gottfried <tom@intevation.de>
parents:
450
diff
changeset
|
9 * Extend or overwrite configuration via `.env.local`-file |
3 | 10 |
11 ``` | |
499
5b7a4327f6c0
Recommend using .env.local instead of copying .env.sample
Tom Gottfried <tom@intevation.de>
parents:
450
diff
changeset
|
12 cp .env .env.local |
3 | 13 ```` |
14 | |
499
5b7a4327f6c0
Recommend using .env.local instead of copying .env.sample
Tom Gottfried <tom@intevation.de>
parents:
450
diff
changeset
|
15 Modify `.env.local` according to your needs. |
5b7a4327f6c0
Recommend using .env.local instead of copying .env.sample
Tom Gottfried <tom@intevation.de>
parents:
450
diff
changeset
|
16 |
3 | 17 * Start Development servers |
18 | |
19 * Javascript | |
20 | |
21 Run webpack-dev-server with `yarn serve` | |
22 | |
1852
72d6fcb2147d
client: add dev-server tunnel hint
Bernhard Reiter <bernhard@intevation.de>
parents:
1802
diff
changeset
|
23 Hint: if you want to access the dev-server via a tunnel with hot reload, |
72d6fcb2147d
client: add dev-server tunnel hint
Bernhard Reiter <bernhard@intevation.de>
parents:
1802
diff
changeset
|
24 you'll may need to explicitely set the url the browser has to call |
72d6fcb2147d
client: add dev-server tunnel hint
Bernhard Reiter <bernhard@intevation.de>
parents:
1802
diff
changeset
|
25 with public. Example: |
72d6fcb2147d
client: add dev-server tunnel hint
Bernhard Reiter <bernhard@intevation.de>
parents:
1802
diff
changeset
|
26 |
72d6fcb2147d
client: add dev-server tunnel hint
Bernhard Reiter <bernhard@intevation.de>
parents:
1802
diff
changeset
|
27 ```sh |
72d6fcb2147d
client: add dev-server tunnel hint
Bernhard Reiter <bernhard@intevation.de>
parents:
1802
diff
changeset
|
28 ssh bern@ourdev.intevation.de -L 8180:localhost:8180 |
72d6fcb2147d
client: add dev-server tunnel hint
Bernhard Reiter <bernhard@intevation.de>
parents:
1802
diff
changeset
|
29 yarn serve --port 8180 --public http://localhost:8180 |
72d6fcb2147d
client: add dev-server tunnel hint
Bernhard Reiter <bernhard@intevation.de>
parents:
1802
diff
changeset
|
30 ``` |
72d6fcb2147d
client: add dev-server tunnel hint
Bernhard Reiter <bernhard@intevation.de>
parents:
1802
diff
changeset
|
31 |
3 | 32 * Build `yarn build` |
33 | |
34 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
|
35 |
1009
76e9296d6191
added demo mode in READMEs
Markus Kottlaender <markus@intevation.de>
parents:
499
diff
changeset
|
36 * Build `yarn build-demo` |
76e9296d6191
added demo mode in READMEs
Markus Kottlaender <markus@intevation.de>
parents:
499
diff
changeset
|
37 sets the hg revision as a node env var and builds the production ready assets to `web` folder. |
76e9296d6191
added demo mode in READMEs
Markus Kottlaender <markus@intevation.de>
parents:
499
diff
changeset
|
38 |
152
a719a3ba2fb4
Client README updated for translations
Thomas Junk <thomas.junk@intevation.de>
parents:
121
diff
changeset
|
39 * Translation |
a719a3ba2fb4
Client README updated for translations
Thomas Junk <thomas.junk@intevation.de>
parents:
121
diff
changeset
|
40 * Extract Messages via `make makemessages` |
1802
70573eea890e
improve Translation process : improve package.json and update the documentation
Fadi Abbud <fadi.abbud@intevation.de>
parents:
1009
diff
changeset
|
41 * Translations are converted via `make translations` which is executed automatically with yarn serve/build |
167
a6d7ee20fc96
docs: Adding documentation on how to run tests
Thomas Junk <thomas.junk@intevation.de>
parents:
152
diff
changeset
|
42 |
168
e4e4a0e6338e
docs: Added a developer documentation
Thomas Junk <thomas.junk@intevation.de>
parents:
167
diff
changeset
|
43 For more information see [developer documentation](./docs/developer.md) |
e4e4a0e6338e
docs: Added a developer documentation
Thomas Junk <thomas.junk@intevation.de>
parents:
167
diff
changeset
|
44 |
167
a6d7ee20fc96
docs: Adding documentation on how to run tests
Thomas Junk <thomas.junk@intevation.de>
parents:
152
diff
changeset
|
45 * Tests |
a6d7ee20fc96
docs: Adding documentation on how to run tests
Thomas Junk <thomas.junk@intevation.de>
parents:
152
diff
changeset
|
46 * 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
|
47 * 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
|
48 |
a6d7ee20fc96
docs: Adding documentation on how to run tests
Thomas Junk <thomas.junk@intevation.de>
parents:
152
diff
changeset
|
49 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
|
50 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
|
51 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
|
52 and see also [Nightwatch documentation](http://nightwatchjs.org/gettingstarted#geckodriver) |