README.md

Fuiz

Host live quizzes freely

Developing

This is the backend component. It can be run with:

cargo run

This will open a server listening to port 8080.

Creating a game

POST /add

Parameter	Type	Description
config	FuizConfig	Required. Config as defined in src/game_manager/fuiz/config.rs
options	FuizOptions	Required. Options as defined in src/game_manager/game.rs

Response

{
  "game_id"    : string,
  "watcher_id" : string
}

Checking if game is alive

GET /alive/:gameid

Response

true | false;

Joining a game (using WS protocol)

GET /watch/:gameid

This establishes a websocket connection. #TODO: documenting websocket messages.

Status

While you could host this yourself, a live version exists on api.fuiz.us. Its status can be checked on: status.fuiz.us.