Skip to content

Commit d7e7438

Browse files
committed
Added credits and app version
1 parent 26e11b7 commit d7e7438

File tree

4 files changed

+28
-5
lines changed

4 files changed

+28
-5
lines changed

.github/ISSUE_TEMPLATE/Bug_Report.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ about: Create a report to help us improve the quiz app.
77

88
_Short summary of what is going on or to provide context_.
99

10+
### App Version
11+
12+
Host app version (see bottom of host game page):
13+
x.y.z
14+
15+
Player app version (see bottom of player registration page):
16+
x.y.z
17+
1018
### Steps To Reproduce:
1119

1220
1. This is step 1.

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -190,19 +190,21 @@ Here is how the game works:
190190
Players start with a zero score. The fastest player to answer a question correctly earns 1000 points.
191191
Players who also answered correctly but slower will earn a decreasing number of points depending on how late they answered. Wrong answers grant no points. The player that scores the most points at the end of the game wins.
192192

193-
**App wake-up time**
193+
**Player app wake-up**
194194

195195
Shortly before running the official game, make sure to access the player app a first time to load it.<br/>
196196
The default Heroku setup uses a free Heroku dyno. This implies that apps that are inactive for more than 30 minutes are put to sleep. Any connection to the app will wake it up but it takes a bit less than a minute. You may experience some "Request time out" errors during that wake-up time.
197197

198-
If you are running the game with 30+ players, consider upgrading to a Hobby dyno (\$7/month).
198+
If you are running the game with 40+ players, consider upgrading to a [Hobby dyno](https://www.heroku.com/dynos).
199199

200200
**Resetting the game**
201201

202202
You can reset the game at any time by clicking on the Reset button on top right of the Quiz app. This resets the quiz session to the registration phase, clears players and previous answers.
203203

204204
## Troubleshooting
205205

206+
Review these common problems. If you can't find a solution to your problem, [open a new issue](https://github.com/pozil/quiz-host-app/issues).
207+
206208
**Problem:** Player app is not updating when switching game phase (from registration to question for example)
207209

208210
**Solution:**
@@ -216,10 +218,14 @@ You can reset the game at any time by clicking on the Reset button on top right
216218

217219
- Reset the game using the Reset button on the quiz app. This resets the quiz session to the registration phase, clears players and previous answers.
218220
- Run the following script wipe ALL quiz data. You'll have to reimport questions.
221+
```
222+
sfdx force:apex:execute -f bin/wipe-data.apex
223+
```
219224
220-
```
221-
sfdx force:apex:execute -f bin/wipe-data.apex
222-
```
225+
**Problem:** You're seeing a "Failed to validate Quiz app settings: Read timed out" error on the host app.
226+
227+
**Solution:**
228+
Refresh the page to fix the problem. Refer to the **Player app wake-up** section of this document for more information.
223229
224230
## Building and contributing
225231

src/main/default/lwc/gameApp/gameApp.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,4 +112,11 @@ <h1 class="answer-label">{correctAnswerLabel}</h1>
112112
</template>
113113
</div>
114114
</div>
115+
<div class="slds-text-align_center slds-text-color_weak">
116+
Quiz App by <a href="https://twitter.com/PhilippeOzil">@PhilippeOzil</a>
117+
&nbsp;-&nbsp;Host app v{HOST_APP_VERSION}&nbsp;-&nbsp;
118+
<a href="https://github.com/pozil/quiz-host-app"
119+
>Help, issues and feedback</a
120+
>
121+
</div>
115122
</template>

src/main/default/lwc/gameApp/gameApp.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ export default class GameApp extends LightningElement {
1414
@track isNextButtonDisabled = true;
1515
@track currentQuestion;
1616

17+
HOST_APP_VERSION = '1.0.0';
18+
1719
@wire(getQuizSettings)
1820
wiredQuizSettings({ error, data }) {
1921
if (data) {

0 commit comments

Comments
 (0)