bbcbox/bbc-box-quiz-app-amd64 repository overview

⁠bbc-box-quiz-app

Databox quiz application that will collect data from the user as part of the bbc-box prototype

⁠commands

• npm start - runs react-scripts, build, server.js and ./scripts/setupDevEnv.sh (access via http://127.0.0.1:3000/bbc-box-quiz-app/ui/⁠)
• npm run build - puts all the assets into the build folder.
• npm run dev - spins up a localhost but not a express server.

⁠running a driver to test agents

Run:

  ./script/startDrivers.sh

This will start the iPlayer driver and set it up to write into the store started by npm start above. The driver will function in the same way as it would inside databox. However there is one key difference. Inside databox the driver would have its own store running on a different host name. Information about the location of data source is passed to the via and environment variable. For testing outside databox there is only one store. The Driver UIs are assessable from http://127.0.0.1:8080/ui⁠ .

Due to a limitation in how the containers are configured we can only start one driver at a time. I will look to see if there is a way around this. The commands to start the other drivers are included in the script and commented out, so switching is easy.

⁠Automatic image builds from the master branch

This repo is now linked to docker hub any new commits to the master branch will force the quiz-app image to be rebuilt. New images take about ten minutes to build. You can check progress here https://hub.docker.com/r/bbcbox/bbc-box-quiz-app-amd64/builds/⁠

Once built you can just restart the quiz-app within databox to pull the newly created image. Happy testing.

⁠Updating the FE on the box

When you run the make start command, docker will create an ID for the quiz app. Everytime you run that command the id will change. This ID is needed so we can then copy over the build assets into the box and visually see our changes.

docker ps | grep bbc-box-quiz-app-amd64

Will get you the ID of the app then when you make a FE change, run npm run build-dev. Make sure the ID you get from the docker ps command is in your package.json file.

⁠Driver authentication

For iplayer and instagram redirect the users to

  /[driver-name]/ui/auth?post_auth_callback=[path-where-the-user-should-end-up]

For spotify its a bit different thanks to the oAuth

  /core-ui/ui/view/[driver-name]/auth?post_auth_callback=[path-where-the-user-should-end-up]&databox_uri=[protocols-and-hostname-that-is-used-to-access-databox-ui]

  eg
  /core-ui/ui/view/spotify-history-driver/auth?post_auth_callback=/bbc-quiz-app/spotify&databox_uri=https://localhost