view client/README.md @ 5711:2dd155cc95ec revive-cleanup

Fix all revive issue (w/o machine generated stuff).
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Tue, 20 Feb 2024 22:22:57 +0100
parents da04fa72cee8
children
line wrap: on
line source

* Install dependencies

  * [Yarn](https://yarnpkg.com/) and a compatible nodejs version
    is needed, see `engines` section in `package.json`.

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