annotate client/README.md @ 289:aee175e3f82c usermanagement

feat: Listing of users on management page Prototypical implementation of listing of all users on management page implemented. Data is fetched before route is entered. Unless the data isn't available the route is not changed. After data is available currently a simple unstyled table with data is rendered.
author Thomas Junk <thomas.junk@intevation.de>
date Tue, 31 Jul 2018 12:02:48 +0200
parents 9f1b84b712a8
children f8d8f12bab91
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
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