view client/README.md @ 3678:8f58851927c0

client: make layer factory only return new layer config for individual maps instead of each time it is invoked. The purpose of the factory was to support multiple maps with individual layers. But returning a new config each time it is invoked leads to bugs that rely on the layer's state. Now this factory reuses the same objects it created before, per map.
author Markus Kottlaender <markus@intevation.de>
date Mon, 17 Jun 2019 17:31:35 +0200
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)