Skip to content

Repository files navigation

Scribble

A multiplayer drawing and guessing game, containerized for easy deployment.

What is used in it and for what

  • Node.js/JavaScript: Core language for the frontend and backend.
  • Docker & Docker Compose: Used to containerize the application, allowing both the client and server to be spun up easily (Dockerfile, docker-compose.yml).
  • WebSockets (Socket.io likely): Facilitates real-time communication between the server and multiple drawing clients.

Architecture

  • /client: Frontend code containing the canvas logic and user interface.
  • /server: Backend code managing game state, player sessions, and broadcasting drawing events.
  • run.bat: A quick Windows batch script to start the local development environment.

How to run it

Using Docker (Recommended):

  1. Ensure Docker Desktop is installed and running.
  2. Run the application via docker-compose:
    docker-compose up --build

Manual Startup:

  1. Navigate to /server, run npm install, and then npm start.
  2. Navigate to /client, run npm install, and then npm start.
  3. Open the provided localhost link in your web browser.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages