-
Notifications
You must be signed in to change notification settings - Fork 3
User Documentation
Nick Andjelkovic edited this page Sep 28, 2016
·
27 revisions
It is assumed that the application is being hosted by the local machine therefore the web address used in this documentation
will be localhost
, please replace this web address to suit your environment.
Index: /index.html (http://localhost/)
Creating a new session: /New (http://localhost/New)
Host Management Interface: /Manage (http://localhost/Manage)
Joining a session: /Join (http://localhost/Join)
Contestant Interface: /Contestant (http://localhost/Contestant)
Results Interface: /Share (http://localhost/Share)
The results interface provides the following features:
|
Alerts, Warnings and Errors
</tr>
<tr>
<td width="50%">
<p>Error: Session not found</p>
<p>Cause: Server does not contain the specified sessionId</p>
<p>Notes: This message is displayed if there is a stale cookie in the browser or the server has been restarted
and all session data has been cleared. A new session will need to be setup and contestants would need
to rejoin.</p>
</td>
<td width="50%">
<a href="https://github.com/damoclark/buzzer.click/wiki/Images/Error_SessionNotFound.png" target="BuzzerWebAppImage"><img src="https://github.com/damoclark/buzzer.click/wiki/Images/Error_SessionNotFound.png" /></a>
</td>
</tr>
<tr>
<td width="50%">
<p>Error: Session <em>data</em> not found</p>
<p>Cause: Client does not contain a session cookie</p>
<p>Notes: This message is displayed if there isn't a valid cookie in the browser or the server has been restarted
and all session data has been cleared. A new session will need to be setup and contestants would need
to rejoin.</p>
</td>
<td width="50%">
<a href="https://github.com/damoclark/buzzer.click/wiki/Images/Warning_NoSessionData.png" target="BuzzerWebAppImage"><img src="https://github.com/damoclark/buzzer.click/wiki/Images/Warning_NoSessionData.png" /></a>
</td>
</tr>
<tr>
<td width="50%">
<p>Error: Username taken</p>
<p>Cause: Session already has a user that has joined with the specified username</p>
<p>Notes: Choose a new username</p>
</td>
<td width="50%">
<a href="https://github.com/damoclark/buzzer.click/wiki/Images/Error_UsernameTaken.png" target="BuzzerWebAppImage"><img src="https://github.com/damoclark/buzzer.click/wiki/Images/Error_UsernameTaken.png" /></a>
</td>
</tr>
<tr>
<td width="50%">
<p>Error: Profanity</p>
<p>Cause: String contains profanity</p>
<p>Notes: This message is displayed if profanity is detected in the username, team name or session name. Choose
another name to continue.
</p>
</td>
<td width="50%">
<a href="https://github.com/damoclark/buzzer.click/wiki/Images/Error_Profanity.png" target="BuzzerWebAppImage"><img src="https://github.com/damoclark/buzzer.click/wiki/Images/Error_Profanity.png" /></a>
</td>
</tr>
<tr>
<td width="50%">
<p>Error: Buzzer not accepted</p>
<p>Cause: Buzzer press was not accepted</p>
<p>Notes: This message indicates that the server is not accepting any buzzer presses. This indicates that the buzzer has either been pressed multiple times, or is disabled due to the game state.
</p>
</td>
<td width="50%">
<a href="https://github.com/damoclark/buzzer.click/wiki/Images/Warning_BuzzerNotAccepted.png" target="BuzzerWebAppImage"><img src="https://github.com/damoclark/buzzer.click/wiki/Images/Warning_BuzzerNotAccepted.png" /></a>
</td>
</tr>
</tbody>
[Developer environment setup](Developer environment setup)
[Coding standards](Coding standards)