view client/README.md @ 168:e4e4a0e6338e

docs: Added a developer documentation Developer documentation was added. At present the rationale for why we chose vue-gettext is documented. Alongside comes the explanation of how to use it and what quirks vue-gettext has.
author Thomas Junk <thomas.junk@intevation.de>
date Fri, 06 Jul 2018 12:38:11 +0200
parents a6d7ee20fc96
children 9f1b84b712a8
line wrap: on
line source

N.N
===

* Install dependencies

  * Javascript

    `yarn install`

* Configuration via `.env`-file

  **Example** given via `.env.sample`

  ```
  cp .env.sample .env
  ````

* Start Development servers

  * Javascript

    Run webpack-dev-server with `yarn serve`

  * If you also want to start the backend, try

    `yarn run:both`

* Build `yarn build`

  builds the production ready assets to `web` folder.

* Translation
  * Extract Messages via `make makemessages`
  * Translations are converted via `make translations`

  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)