Real-Time Drawing and Guessing Game

Badges

Project Description

This project is a Flask-SocketIO web application designed for real-time communication and interaction through a drawing and guessing game. Players can join rooms, participate in drawing, guess drawings made by others, and see real-time updates.

Team Members

Dhiyaa Al Jorf

Firas Darwish

Shubhi Upadhyay

Deployment Link

https://fizzbuzz-draw-5d5v2.ondigitalocean.app/

Docker Container

Link to the container image for the custom subsystem: https://hub.docker.com/r/doodyshark/se-project-5

Getting Started

Follow these instructions to run a copy of the project on your local machine.

Running the Project

Running from DockerHub Image

1. Pull built image from DockerHub

   docker pull doody-shark/se-project-5:main
   

2. Run image with port 8080 exposed with interactive termianl

   docker run - ti -p 8080:8080 doody-shark/se-project-5:main
   

This will open up the server on localhost:8080

Running from Github Repository

1. Clone the Repository

   git clone https://github.com/software-students-spring2024/5-final-project-spring-2024-team-fizzbuzz-final.git
   
   cd 5-final-project-spring-2024-team-fizzbuzz-final
   

2. Create a .env file in the root of the directory with the following contents

MONGODB_USER=your_mongodb_user
MONGODB_PASSWORD=your_mongodb_password
MONGODB_HOST=your_mongodb_host
MONGODB_NAME=your_database_name
MONGODB_AUTHSOURCE=admin
MONGODB_PORT=27017
WEBAPP_FLASK_SECRET_KEY=your_secret_key
WEBAPP_FLASK_PORT=5000
WEBAPP_FLASK_ENV = development
WEBAPP_FLASK_APP = app.py

3. r To run the project, use

   docker build -ti --tag game .
   docker run -ti -p 8080:8080 game
   

This will open up the server on localhost:8080