Running reference application

Project Structure

  • Volunteer Client Application /client
  • Admin Application /client-admin
  • Server Application /server
  • Data Model Representing System API ./model
  • OpenShift Deployment ./.openshift

Getting Started


  • Node.js 12.x or later version
  • Docker and Docker Compose
  • Access to a running OpenShift instance (Optional)

Running Apps and Server

  1. Install yarn and project dependencies
npm install -g yarn
  1. Build client admin and client
yarn prepare:all
  1. Start the server
cd ./server
docker-compose up -d
## Wait at least minute for containers to start
yarn keycloak:init
yarn start
  1. Links to applications should be printed in the console.
🎮 Ionic PWA application available at http://localhost:4000
🎮 Admin PWA application available at http://localhost:4000/admin

By default, the two users that can log into the application are created:

  • username: developer; password: developer
  • username: admin; password: admin Volunteers can register to the application in the login screen.

Technical Details

Keycloak Integration

Follow these instructions to set up Keycloak for Authentication/Authorization.

  1. Configure the Keycloak Server

    cd ./server
    yarn keycloak:init

    This command creates the necessary resources in Keycloak and prints instructions you must follow to enable the integration.

  2. Follow the printed instructions and copy the JSON configurations to the appropriate locations. The Starter app and server will read these configurations and the integration will be enabled when they are started.

Volunteer accounts for logging to voulnteer app that can be used:


Admin application user:


The password is the same as the username.

NOTE: If you'd like to use demo data users and have them automatically imported in keycloak, run the keycloak init script as below:

USE_DEMO_DATA=false yarn keycloak:init

This command will create the following usernames:


The password is the same as the username.

You can use these user names to login into the volunteer client application.

Running Clients as Mobile Applications

For IOS:

cd ./client
yarn cap add ios
yarn run:ios

For Android:

cd ./client
yarn cap add android
yarn run:android

When running locally you will need to also enable HTTP traffic. For example, for Android add android:usesCleartextTraffic#"true" to AndroidManifest.xml

The project should start in IDE and can be launched as any other native application.

Using MQTT for GraphQL Subscriptions

By default, the platform uses an in memory subscription mechanism that is not recommended for production. For OpenShift deployment, the AMQ MQTT protocol is used. On your local machine, this can be configured using the following steps:

  1. Go to server/scripts ./mqtt
  2. Execute docker-compose
  3. Set the MQTT_HOST variable in the .env file. MQTT_HOST#

Running On OpenShift

Please check out the .openshift folder for more information.


The Starter template is based on the Graphback open source project. Please follow the Graphback Getting Started Guide to learn how to modify the Open Volunteer Platform.

Executing Graphback source generator

The following command generates client side queries and mutations for the client side:

yarn generate:all