Your quiz hero. A lightweight and responsive frontend for a quiz prediction robot. Demo
npm is used to manage the dependencies of HQhero.
npm install will install all dependencies
Please see herobrain documentation for further information on connecting herobrain to hqhero
npm startto build the client and start the server in development modenpm run build-clientto build the client for distributionnpm run build-serverto build the server for distributionnode server-build/server.jsto run the built server and client
HQhero uses Websockets to transmit the information quickly, easily, and efficiently.
It requires a quiz processor to transmit answer predictions and other information about the game to the service. The processor sends events to hqhero, where it will then broadcast those events to all connected users.
hqhero.com uses herobrain as a processor.
| Method | URI | Body | Description |
|---|---|---|---|
| POST | /hero/waiting | {"info": {"prize"?: string, "nextGame"?: string}} |
Waiting for the next game, prize and next game are optional |
| POST | /hero/starting | {"info": {}} |
The game is starting |
| POST | /hero/round | {"info": {"numRounds": number, "question": {"question": string, "choices": string[]}, "num": number, roundNum: number}} |
Next round has started |
| POST | /hero/analysis | {"info": AnalysisObject} |
Analysis of the round. Not used on the frontend, but broadcast. |
| POST | /hero/prediction | {"info": {"answers": Dict<string,number>, "best": string, "speed": number}} |
Prediction of choices |
| POST | /hero/answers | {"info": {"eleminated": number, "advancing": number, "answer": string, "answers": Dict<string,number>}} |
Conclusion of round. answer and answers are the only implimented data keys. Others are broadcast but not used on the front-end |
| POST | /hero/ended | {"info": {}} |
Not implimented, game transisions using waiting |
API response is always {success: true} for a successful input
Deploying this webapp as a container is the recommended practice.
herobrain should be pointed
towards your hqhero service.
HQhero is designed to only have a single service running. It is designed with a reverse proxy in mind for routing. Multiple HQhero services can be configured to represent different quiz regions and then routed to via a reverse proxy.
In this example, hqhero is designed for /uk /us and /de.
When deploying, please remove the gtag in main.ts from your client.
Feel free to add your own.
hqhero.com is the current host of HQhero. We currently receive 600+ users a day, with a viewership in 80+ countries.
We opensourced HQhero in the hope that it is useful for others to read or take inspiration from
Contributing is welcomed, but not needed. HQhero is a completed project. herobrain is where contribution should be aimed at to make the quiz prediction better.
However, please submit feel free any pull requests with features or bug fixes.
HQhero is released under the MIT license. Logo is Copyright Eddie Reeder
- Oliver Bell - Backend, Architecture, DevOps
- Eddie Reeder - Frontend, Design, Animation, Logo