How to spin up the v3 stack

This guide will show you how to swap between v2 and v3 of the Author-Runner stack. This is written under the assumption that you have already spun up the v2 stack.

You will need...

1. The following repositories cloned:

   • eq-author-app
   • eq-publisher-v3
   • eq-questionnaire-runner

2. To have stopped your running docker containers

Steps

1 - Author front end

The front end of Author has not changed between v2 and v3.

1. Move into the eq-author-app repository

   $ cd eq-author-app

2. Move into the eq-author directory

   $ cd eq-author

3. Fire up the front end

   $ yarn start

2 - Author API

The Author API now uses Cloud Firestore as its database instead of DynamoDB, as we have moved from hosting the product on Amazon Web Services to Google Cloud Platform. Additionally, a new endpoint has been created, /convert, which allows external services to retrieve EQRunner v3 schemas via our API instead of by targetting Publisher directly.

1. Open docker-compose.yml
2. Update the following enviornment variable values:
   • DATABASE=firestore
   • PUBLISHER_URL=http://docker.for.mac.localhost:4000/convert/
3. Add this new enviornment variable to the list:
   • CONVERSION_URL=http://docker.for.mac.localhost:9000/publish/
4. Move to the eq-author-app repository in the terminal

   $ cd eq-author-app

5. Move to the eq-author-api directory

   $ cd eq-author-api

6. Fire up the API

   $ Docker-compose up

3 - Publisher v3

We have developed a new version of Publisher to accomodate the changes that the new EQRunner introduces.

1. Move into the eq-publisher-v3 repository

   $ cd eq-author-app

2. Install dependencies and fire up Publisher in development mode

   $ yarn && yarn develop

Development mode includes Nodemon. If you would like to run the application without this, use yarn start instead.

4 - EQRunner v3

This new version of EQRunner introduces a new schema format and various technology changes, notably using Cloud Datastore for its database solution and is hosted on the Google Cloud Platform.

1. Move into the eq-questionnaire-runner repository

   $ cd eq-questionnaire-runner

2. Fire up the application

   $ docker-compose up -d

Final notes

You should now have the v3 stack up and running. Each stack uses the same ports so be sure to keep that in mind when swapping between the two.