A brief description of what this project does and who it's for.
Instructions on how to install the project or setup the development environment.
- Python 3.8
- Pip
Create a python venv and activate it:
python3 -m venv .venv
source venv/bin/activateInstall the required packages:
pip install -r requirements.txtInstructions on how to use the project after installation.
To run the server, you need to set the PYTHONPATH environment variable to the project directory:
export PYTHONPATH="${PYTHONPATH}:/path/to/project"Then, run the following command to start the server:
flask run --host=localhost --port=8080GET /ping Check if the server is running.
GET /draw Draw a random card from a deck.
PUT /end_of_turn End the current turn. switch to the next player.
POST /enter_lobby_by_id Join or create a lobby by id.
POST /play_card Play a card from the player's hand.
PUT /question Ask a question to the player.
PUT /update get the current state of the game.
The frontend of the project is a Vite.js React application. You can find the repository here.