diff --git a/frontend/README.md b/frontend/README.md index 2b91ffa65c93f8f0322e24aefd7f9552cea118a4..5140968964b3de2dbc879e633338be2b66375199 100644 --- a/frontend/README.md +++ b/frontend/README.md @@ -3,7 +3,7 @@ After installing `npm` run ``` -npm install +npm install --production ``` Start the application in debug mode with @@ -19,11 +19,16 @@ npm run build npm run start ``` +or + +``` +npm build-start +``` ### Configuration Configuration has to be specified in `nuxt.config.js`. Setting the OpenID Connect paramaters -correctly is essential for the login process to work +correctly is essential for the login process to work. For details on how to configure authentication for external providers like GitHub or Facebook please refer to [the nuxt-oauth documentation](https://auth.nuxtjs.org/schemes/oauth2.html) @@ -41,3 +46,20 @@ your browser to the URL. Note that you need to manually provide a cookie containing the Baerer token in case you don't access the api with a browser that automatically includes your cookie in the request. Passing the token as a GET or POST variable is not supported. + + +### Run the tests + +Install the development dependencies with + +``` +npm install # without --production +``` +Configure the application as described above. +After creating a regular user and an admin user by assigning the role `admin` to the admin +user and granting both users access to the `user-panel` application, configure the default +values in `test/nightwatch_globals.js`. After that, run `npm test`. + +Note: E2E tests are executed with chromedriver. Make sure that you have a supported version +of chromium installed. To downgrade the chromium version that is used in the tests, change +the version number in `package.json` [accordingly](https://www.npmjs.com/package/chromedriver).