/Lets-scribble

Real-time online multiplayer pictionary game driven by WebSockets. React-typescript client, node.js server, game & room data management using Redis.

Primary LanguageTypeScript

Lets-scribble

An online multiplayer pictionary game driven by WebSockets.

Setup Instructions:

Install dependencies:

npm install
cd react-client
npm install

For running in Development Mode:

  • Backend (runs on port 3001 by default):
npm run dev
  • Frontend:
cd react-client
npm start

For running in Production Mode:

  • Runs on port 3001 by default.
cd react-client
npm run build
cd ..
npm start

Make sure you have a redis instance running on your machine.

Also, create a .env file in the root of the project with the following content:

REDIS_HOST = YOUR_REDIS_HOST_URL
REDIS_PORT = YOUR_REDIS_PORT
REDIS_PASSWORD = YOUR_REDIS_PASSWORD
  • You can also add a PORT key if you wish to run the application on a different port than default.
  • If running in development mode, you do not need to provide REDIS_HOST and REDIS_PORT. REDIS_PASSWORD also not required if no password has been set.