extract secrets to env, use docker compose
This commit is contained in:
parent
14ba148284
commit
c8300f5978
16 changed files with 186 additions and 133 deletions
48
README.md
48
README.md
|
|
@ -1,27 +1,5 @@
|
|||
### Welcome to QUIZTerm
|
||||
|
||||
QUIZTerm is a simple online "quiz answering" game. It provides a way for contestants to provide answers to questions,
|
||||
and reveal the answers for everyone at the same time.
|
||||
|
||||
Cards showing who are playing, their answer status (have they answered or not?), and when revealed, what their answer
|
||||
was, will show up on everyones screen.
|
||||
|
||||
Not quite finished yet, it is at a point where it is "usable" enough.
|
||||
|
||||
Endpoints explained
|
||||
|
||||
| Endpoint | Usage |
|
||||
|--------------------------|--------------------------------------------------------------|
|
||||
| /room/<room_id> | Create room with given room_id (max 200 rooms) |
|
||||
| /board/<room_id> | Join a game with the given room_id |
|
||||
| /board/<room_id>/control | Join a game with the given room_id with more control options |
|
||||
|
||||
|
||||
| Ingame example | Idle player |
|
||||
|--------------------------|--------------------------|
|
||||
|  |  |
|
||||
|
||||
### Building and running
|
||||
## Building and running
|
||||
|
||||
Docker, or a compatible container manager, like podman, is required to build and run
|
||||
quizterm. The alternative is to install Gleam and Erlang/BEAM and run it dockerless.
|
||||
|
|
@ -44,3 +22,27 @@ is the port exposed outside the container. The latter can be set to whatever
|
|||
port you want to use.
|
||||
|
||||
Open web browser and access http://localhost:4321
|
||||
|
||||
## The rest of this readme is currently outdated and will be updated shortly
|
||||
|
||||
QUIZTerm is a simple online "quiz answering" game. It provides a way for contestants to provide answers to questions,
|
||||
and reveal the answers for everyone at the same time.
|
||||
|
||||
Cards showing who are playing, their answer status (have they answered or not?), and when revealed, what their answer
|
||||
was, will show up on everyones screen.
|
||||
|
||||
Not quite finished yet, it is at a point where it is "usable" enough.
|
||||
|
||||
Endpoints explained
|
||||
|
||||
| Endpoint | Usage |
|
||||
|--------------------------|--------------------------------------------------------------|
|
||||
| /room/<room_id> | Create room with given room_id (max 200 rooms) |
|
||||
| /board/<room_id> | Join a game with the given room_id |
|
||||
| /board/<room_id>/control | Join a game with the given room_id with more control options |
|
||||
|
||||
|
||||
| Ingame example | Idle player |
|
||||
|--------------------------|--------------------------|
|
||||
|  |  |
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue