sridhar-sp / draw-server

A multi-player drawing game to play with your friends and family.

Draw & Guess Game Server

A multi-player drawing game to play with your friends & family.

This is a drawing game where one player draw a given word and others will try to guess the word. Each player will take a turn on drawing and guessing. The scores will be assigned based on how quick participant guessed the word and how well their drawing is understood by other players.

Requirements

• Local development will need Node.js, npm, Redis and RabbitMQ installed in your environement.
• The application is dockerized so you can use docker also for local development.

Install

$ git clone https://github.com/sridhar-sp/draw-server
$ cd draw-server
$ npm install

Run server

Start the application server

$ npm start

This project is configured with the 'ts-node-dev'. If you make some changes and wanted those changes apply immediately without restarting the server. Use the below command to start the application

$ npm run dev

Run using docker

$ docker-compose up

Docs

• Run /api-docs end point to get the full api documentation
• Usecase and sequence diagrams

Credits

The sequence diagrams are created using js-sequence-diagrams

Android client application

See client application screens

draw-server's Issues

Close Redis connection on process termination

Try to validate whether it's necessary to close the redis connection on process termination

Change the socket event strings

Use "request:" and "response:" for request and response respectively

Remove old RedisHelper class

Remove old RedisHelper file which returns the object instead of the class type. and use the new RedisHelperSingleton file

Remove production url from swagger index fiile

Load stage and prod server details from config file into the swagger index file

Validate whether a common schema is needed when sending request from client to server via socket.emit method

Currently the payload is sent as is, without wrapping the payload in any structure.

Add test

Store task-id with the expiry time

When saving task-id in TaskRepository, save it with the expiry time so that additional housekeeping task is not required

Clear ghost timeout.

Clear setTimeout from getRandomWords method in WordsRepository

Migrate from Kotlin synthetics to Jetpack view binding

https://developer.android.com/topic/libraries/view-binding/migration

Use a database to store the task record instead of storing the task record in redis

Find alternative for auth server

Currently firebase is used as a auth server, but it's not reliable. It's failed to return success response so often and takes longer time to recover.
So find other auth server, or build one.

If going to build a custom one, try to incorporate that as a microservice

Add more log statements

Add more logs

Example : Firebase authentication

Explore ideas to trace the request

Explore ideas to trace the request using open source tracing library zipkin or open-tracing