https://github.com/rachelconn/CollabSketch

Collaborative sketching web app with WebSockets and paper.js
https://github.com/rachelconn/CollabSketch

Last synced: 9 days ago
JSON representation

Collaborative sketching web app with WebSockets and paper.js

• Host: GitHub
• URL: https://github.com/rachelconn/CollabSketch
• Owner: rachelconn
• Created: 2021-03-10T22:37:53.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-03-11T22:11:45.000Z (over 3 years ago)
• Last Synced: 2024-04-09T14:24:22.808Z (7 months ago)
• Language: TypeScript
• Size: 372 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# About

This is a web app that allows users to collaboratively draw using WebSockets for communication.

You can switch to the brush tool by pressing 1, and the eraser tool by pressing 2.

# Server Setup

Before clients will be able to connect, you must host the provided WebSocket server.

This can be done with the following steps:

- Install python 3.6 or higher (this was tested with 3.8.5)

- Use a virtual environment if you want, and run `pip install websocketserver/requirements.txt`.

- Run the server with `websocketserver/run_sketch_server.py`.

# Client Setup

This project uses npm for dependency management, follow these steps:

- Run `cd src`

- Run `npm i`

- Run `npm run build` to build for production, or `npm run dev` to make a development build.

- Open `index.html`. As long as the sketch server is running, you should be able to share drawings

between clients on different tabs, browsers, and computers.