view client/README.md @ 2455:54c9fe587fe6

Subdivide SQL function to prepare for improved error handling The context of an error (e.g. the function in which it occured) can be inferred by the database client. Not doing all in one statement will render the context more meaningful.
author Tom Gottfried <tom@intevation.de>
date Fri, 01 Mar 2019 18:38:02 +0100
parents 72d6fcb2147d
children b5619087e3e9
line wrap: on
line source

* Install dependencies

  * Install (`xgettext`) tool (e.g. for Debian xgettext (GNU gettext-tools) 0.19.8.1)

  * Javascript

    `yarn install`

* Extend or overwrite configuration via `.env.local`-file

  ```
  cp .env .env.local
  ````

  Modify `.env.local` according to your needs.

* Start Development servers

  * Javascript

    Run webpack-dev-server with `yarn serve`

Hint: if you want to access the dev-server via a tunnel with hot reload,
 you'll may need to explicitely set the url the browser has to call
 with public. Example:

```sh
ssh bern@ourdev.intevation.de -L 8180:localhost:8180
yarn serve --port 8180 --public http://localhost:8180
```

* Build `yarn build`

  builds the production ready assets to `web` folder.

* Build `yarn build-demo`
  sets the hg revision as a node env var and builds the production ready assets to `web` folder.

* Translation
  * Extract Messages via `make makemessages`
  * Translations are converted via `make translations` which is executed automatically with yarn serve/build

  For more information see [developer documentation](./docs/developer.md)

* Tests
  * Unit tests are started via `yarn test:unit`
  * e2e tests are started via `yarn test:e2e`

    Vue cli supports the Chrome selenium driver out of the box
    If you are interested in using the Firefox variant of the driver
    see [Vue CLI Plugin Docs](https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-e2e-nightwatch)
    and see also [Nightwatch documentation](http://nightwatchjs.org/gettingstarted#geckodriver)