The survey player is part of the k:evatool and holds the user frontend needed to display a survey or single question. The player connects to the k:evatool backend through the RESTful API using a maximum of three endpoints to get the survey and post the result data and if applicable the audio file data of a voice recording.

This project is part of the project museum4punkt0 - Digital Strategies for the Museum of the Future, sub-project k:eva. Further information: https://www.museum4punkt0.de.

The project museum4punkt0 is funded by the Federal Government Commissioner for Culture and the Media in accordance with a resolution issued by the German Bundestag (Parliament of the Federal Republic of Germany).

Please copy the file .env.local.example to .env and adjust the parameters:

• VITE_API_BASE_URL: Set the base URL of the k:evatool backend (i.e. http://localhost:8085/api for local development)
• ELECTRON_FULLSCREEN: Configure if the electron build runs in fullscreen mode or as a floating window

Please make sure that the Laravel Backend is running. Otherwise backend connection and saving answers won't be possible.

The following needs to be run for production and development prior to building and running the dev environment

yarn

yarn dev

Like on a webserver. Ideal for testing builds locally.

yarn serve

yarn build

yarn lint (--fix)

Builds a standalone installable app for either windows or mac

yarn electron:win
yarn electron:mac

From the admin frontend you can copy the links (URLs) that link to the survey player. The links base URL is defined during the build process of the admin frontend through the respective .env file

You can run the player in demo mode by adding the demo url parameter (i.e. https://your-keva-player.com?demo=true). When running in demo mode the results generated by the user are stored with a demo flag and can be filtered in the admin frontend. This is ideal for testing a survey without producing live results. Demo mode also shows a button in the lower left corner of the survey player that allows resetting the uuid to execute a survey again with a fresh uuid creating a fresh dataset. Please avoid distributing URLs with the demo parameter through marketing, social media, etc.

You can run the player in kiosk mode by adding the kiosk url parameter (i.e. https://your-keva-player.com?kiosk=60). The number sets the timeout in seconds that resets the uuid and goes back to the starting point after user inactivity.

You can run the player with an autoclose query parameter (between 0 and 30 ... seconds). Example: https://your-keva-player.com? autoclose=5). The number sets the timeout in seconds after which the close event "gpwebevent:window.close" is sent. This event can be intercepted in an app.

GNU GENERAL PUBLIC LICENSE
Copyright © 2022, 2av GmbH
Please also see the LICENSE file provided within this repository