Quiz Party API

A quiz app that allows multi game rooms and multi players within a game room at the same time. If you are looking for a game for party drink forfeit, this is what you need.

Main Features

• A user can either host a game (master) or join a game by game code (shared by master)
• Host is able to copy game code and share with other player(s)
• Host is able to make custom quiz or pick up a random quiz that suggested by the system
• Host can also set up the timer (interval every 5 seconds from 10s up to a minute)
• Player can choose and readjust the answer before the timer is up
• If a player selected the right answer, the player will be added as one score to the win counts
• Host is able to reset all the players' score and start over a new count.
• If master left, the game will be announced over. If a player left, the player will be removed from player's list.
• Different game rooms are completely isolated.
• All aboves happen in real time.

Main Technologies

• Node.js
• Socket.io
• Docker

How to start

Note: To enjoy this app, you need this repo to provide the UI, please follow the instruction to start the frontend.

1. Copy the environment variable to .env from .env.example by

   cat .env.example >> .env
   

2. Please install Docker if you hasn't, don't worry, it is still free 😆 !

3. Make sure your Docker is up and running and host machine and docker environment are all available for port: 7000. Then run

   make restart
   

   You can access the API on your host machine via post 7000. Check if the app is up and running by

   curl -X GET http://localhost:7000/healthcheck
   

4. To stop the container, run

   make down
   

For more come in handy commands, please refer to Makefile

✨✨✨✨✨✨Welcome any ideas to make this project better! Happy Coding 👩🏻‍💻✨✨✨✨✨✨