vs4vijay / aesir

A Realtime Collaboration App using Socket.io

Realtime Sync

Deployed Version: https://realtime-sync.herokuapp.com/

Functionalities

• User can use 3 sliders to rotate the Cube on X, Y or Z Axis
• Clicking on Button and Anywhere on the canvas changes the color of Cube randomly
• Any other clients connected at the same time will receive all the events and changes will be reflected instantly

---

Tech. Stack

• NodeJS + Express for APIs and Serving Static Files
• Socket.io for Real Time Communication
• Processing (p5.js) for Drawing UI
• Docker for Containerization

---

Limitations

• Currently, only default namespace is used, but We can make use of socket.io's rooms option to make multiple rooms
• Since Socket.io can use WebSockets or Long Polling (If client doesn't support WebSockets), then Auto Scaling won't be possible by default. We might need to use Sticky Session on Load Balancer to Work properly

---

Future Enhancements

• Can have multiple rooms/channels functionalities
• Cube drawing can be enhanced
• framerate is currently set as 30 FPS, this can be configured from "FRAME_RATE" config variable in "public/client-app.js"
• Frontend App codebase ("/public" folder) can be made modular
• Currently using Structured Logging (from pino logger), but We can have an Event Store (Part of Event Sourcing Implementation) on Server side which will track all the events published
• Can use Redis Adapter to Scale out application on multiple nodes

---

Other Alternatives

• WebRTC
• Pusher
• Deepstream.io
• Firebase

---

Development Notes

aesir's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• fix(deps): update dependency dotenv to v16

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• chore(deps): update node.js to v14.21.3
• fix(deps): update dependency dotenv to v8.6.0
• fix(deps): update dependency express to v4.19.2
• fix(deps): update dependency pino to v6.14.0
• fix(deps): update dependency socket.io to v4.7.5
• chore(deps): update node.js to v20
• fix(deps): update dependency pino to v9
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

docker-compose

docker-compose.yml

dockerfile

Dockerfile

• node 14.15.3-alpine

npm

package.json

• dotenv ^8.2.0
• express ^4.17.1
• pino ^6.5.1
• socket.io ^4.0.1
• node 12.22.x

---

• Check this box to trigger a request for Renovate to run again on this repository