view client/README.md @ 4740:2440d2f86f4e

Authorize sections based on country of creator Disregarding the area of resposibility will allow to create sections outside of the country of the user in order to allow data analysis and aggregation based on sections spanning over multiple countries.
author Tom Gottfried <tom@intevation.de>
date Fri, 18 Oct 2019 12:04:04 +0200
parents b86367910f86
children a74390e92c3c
line wrap: on
line source

* Install dependencies

  * [Yarn](https://yarnpkg.com/) and a compatible nodejs version (>=8.10.0)
    is needed.

  * 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.
  This is what the `../Makefile` will call, which you should use anyway.

  For a real production use, edit the `title` tag in `public/index.html`
  to something matching your installation.


* 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)