I Built an Online Collaborative Canvas using Redis as my Primary Database 🎨

i-built-an-online-collaborative-canvas-using-redis-as-my-primary-database-

Overview of My Submission

This week, I built Collanvas, a collaborative drawing platform with no login required, and where every user has access to only one color.

🧠 I created Collanvas for various reasons, one of them is brainstorming. Go draw the next big thing!

🎨 You can also use Collanvas for art. With one color per person, each one can focus on a specific part of the design.

🏆️ And of course, you can also play games on Collanvas. With the chat feature, play draw-and-guess with your mates until your energy is full again.

Submission Category:

MERN Mavericks

Language Used

JS/TS/Node.js

GitHub logo

eludadev
/
collanvas

Your whole team, changing the world one stroke at a time.

Collanvas — Your whole team, changing the world one stroke at a time 🎨

With an online whiteboard, you can brainstorm 🧠, draw art 🖌️, and even play games 🕹️ with your teammates and your friends. No login is required, and each user has access to the chatroom, a real-time messaging platform to have all kinds of discussions. Choose your own username, pick your own color palette, and go draw the next big thing! 🚀

Collanvas Home Page

Collanvas Room Page with a drawing of the text 'Redis' and a smiley face, and 2 chat messages from different people spelling 'Woohoo!'

How it works

How the data is stored:

Strokes data model

Data Description Type
Color The color of the stroke String (HEX)
Thickness The thickness of the stroke Number (1 to 10)
Type Whether stroke is pen or eraser String (‘Pen’ or ‘Eraser’)
Points The points that make up the stroke {x: Number,y: Number}[]

Keys are generates like canvas:{roomKey}. For each generated key, data is stored by running the ARRAPPEND command like: JSON.ARRAPPEND canvas:{roomKey}

Additional Resources / Info

How did I build Collanvas? Let’s get technical.
We’re storing two JSON documents per room:

Strokes db model

  1. The first one is strokes, a collection of every stroke on the canvas. We collect the stroke color, thickness, type, and the set of points that make it up. Type dictates whether the stroke is in “pen”-mode or “eraser”-mode.

Messages db model

  1. Next and last document is messages, an array of every sent message in the room. We collect the user-name, user-color and the content of the message.

We’re using Redis Insight to inspect our database and confirm our data modeling strategy.

Drawing Done event

But when should we start saving data in these documents? Well, firstly, when the user lifts their pointer from the canvas, we add the drawn stroke to the Redis JSON store with the arrAppend command.

Message event

Lastly, when the user sends a new message, that’s when we save their thoughts to the document with the same command.

API Route

Okay, but why are we saving all this data? Well, when the user first joins a room, we get them started by reading every stroke and message from the database and inserting them in their website.

Websockets

Sounds good, but how do we update Collanvas for every user in real-time? Well, we’re using web-sockets to create a channel of communication between the server and the browser. When the server receives information that, say, a new message just got sent, it will feed that information back into the browser and it will be added without reloading the page.

Redis PubSub

But how do we make different socket connections talk with each other? Redis solves this problem through their Publisher-Subscriber service. Each connection subscribes and publishes to its own two channels of messages and strokes, relaying all information to the browser.

Total
0
Shares
Leave a Reply

Your email address will not be published. Required fields are marked *

Previous Post
disco.pics-–-free-and-open-source-image-hosting-service

Disco.pics – Free and open source image hosting service

Next Post
microsoft-planner:-pros,-cons-and-alternatives

Microsoft Planner: Pros, Cons and Alternatives

Related Posts