Mercurial > gemma
annotate client/README.md @ 206:cd6ad5eaef8d
Renamed cmd/tokenserver to cmd/gemma.
author | Sascha L. Teichmann <teichmann@intevation.de> |
---|---|
date | Sun, 22 Jul 2018 10:40:17 +0200 |
parents | 9f1b84b712a8 |
children | f8d8f12bab91 |
rev | line source |
---|---|
3 | 1 N.N |
2 === | |
3 | |
4 * Install dependencies | |
5 | |
6 * Javascript | |
7 | |
8 `yarn install` | |
9 | |
10 * Configuration via `.env`-file | |
11 | |
12 **Example** given via `.env.sample` | |
13 | |
14 ``` | |
15 cp .env.sample .env | |
16 ```` | |
17 | |
18 * Start Development servers | |
19 | |
20 * Javascript | |
21 | |
22 Run webpack-dev-server with `yarn serve` | |
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 | 28 * Build `yarn build` |
29 | |
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 |
168
e4e4a0e6338e
docs: Added a developer documentation
Thomas Junk <thomas.junk@intevation.de>
parents:
167
diff
changeset
|
36 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
|
37 |
167
a6d7ee20fc96
docs: Adding documentation on how to run tests
Thomas Junk <thomas.junk@intevation.de>
parents:
152
diff
changeset
|
38 * Tests |
a6d7ee20fc96
docs: Adding documentation on how to run tests
Thomas Junk <thomas.junk@intevation.de>
parents:
152
diff
changeset
|
39 * 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
|
40 * 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
|
41 |
a6d7ee20fc96
docs: Adding documentation on how to run tests
Thomas Junk <thomas.junk@intevation.de>
parents:
152
diff
changeset
|
42 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
|
43 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
|
44 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
|
45 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
|
46 |
170
9f1b84b712a8
fix: updated API spec
Thomas Junk <thomas.junk@intevation.de>
parents:
168
diff
changeset
|
47 * Swagger API Specification |
9f1b84b712a8
fix: updated API spec
Thomas Junk <thomas.junk@intevation.de>
parents:
168
diff
changeset
|
48 |
9f1b84b712a8
fix: updated API spec
Thomas Junk <thomas.junk@intevation.de>
parents:
168
diff
changeset
|
49 `yarn swagger` opens the current API specification |