/quiz-host-app

Multiplayer quiz app built on Salesforce technology (host app)

Primary LanguageApexCreative Commons Zero v1.0 UniversalCC0-1.0

Multiplayer quiz app built on Salesforce technology (host app)

Github Workflow

  1. About
  2. Installation
  3. Building and contributing

About

This application is a multiplayer game entirely built on Salesforce technology. A game host presents questions from a Salesforce Org on a shared screen or a video projector. Players compete by answering those questions in real-time using a Lightning Web Component Open Source mobile application hosted on Heroku. The fastest player to give the correct answer scores the most points. As the game progresses, leaderboards are displayed so that players can keep track of scores and ranks.

The quiz app was launched during Developer Game Night at Dreamforce 2019.

Quiz registration at Dreamforce 2019
Quiz host app showing question Quiz player app showing answer buttons Quiz leaderboard at Dreamforce 2019

Installation

Requirements

The quiz requires two applications: a host app and a player app.

The host app is a Lightning Web Component (LWC) app running on a Salesforce Org. You'll need a free Salesforce Developer Edition (DE) org or a scratch org.

The player app is a mobile app built with Lightning Web Component Open Source (LWC OSS). It runs on Node.js depoyed on Heroku. You'll need a free Heroku account to set it up.

Steps

  1. Run install-dev.sh to deploy the host app on a scratch org
  2. Generate a security token for your user
  3. Deploy the Quiz Player App to Heroku by clicking this button:

    Deploy to Heroku

  4. In your Salesforce org, go to Setup > Remote Site Settings and add the player app URL.
  5. Go to Setup > Custom Metadata Types and add a Quiz Settings record.

Building and contributing

If you want to build the project from sources and contribute, run npm install to install the project build tools.

Here is the Quiz Player App.