Giter Club home page Giter Club logo

whiteboard's Introduction

Whiteboard

A simple whiteboard application

Prerequisites

You need to install Docker and Docker Compose.

Getting started

Run:

$ docker compose up

By default, the application uses ports 3000 and 5000, but it is possible to change them by setting the environment variables $CLIENT_PORT and $SERVER_PORT, respectively.

Usage

The application have basic tools like pencil, eraser, color picker, an so on.

It is possible to access rooms with their own whiteboard, and every person in the room will share it. For instance, you can access the room 'room' by going to to the path '/room'. By default, the path '/' is not a shared room, so each person that accesses it will have their own private whiteboard.

The rooms do not keep the whiteboard's state, so basically the state is kept by the people in the room, and therefore, if there is no one in it, the whiteboard's content is lost. Moreover, since there is no stored state, every time a new person enters the room, they need to wait for another person that was already in the room to change the whiteboard, so that the update can be shared between the users.

whiteboard's People

Contributors

availablenick avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.