Skip to content

cmu-variability/blockly-websocket-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Blockly Collaboration WebSocket Server

This server handles real-time synchronization for the collaborative Blockly editor using Yjs.

How it works

  • Built with Yjs for conflict-free real-time collaboration
  • Uses WebSockets for efficient real-time communication
  • Handles multiple rooms for separate collaboration spaces

Deployment Options

This WebSocket server needs to be deployed to a service that supports WebSockets and persistent connections.

Option 1: Deploy to Render.com (Recommended)

  1. Create an account at Render.com
  2. Create a new Web Service
  3. Connect to your GitHub repository
  4. Use the following settings:
    • Environment: Node
    • Build Command: npm install
    • Start Command: node server.js
    • Plan: Free or Starter ($7/month for better uptime)

Option 2: Deploy to Fly.io

  1. Install the Fly CLI: curl -L https://fly.io/install.sh | sh
  2. Login to Fly: fly auth login
  3. Launch the app: fly launch
  4. Deploy: fly deploy

Option 3: Deploy to Heroku

  1. Install the Heroku CLI and login
  2. Create a new app: heroku create your-app-name
  3. Add the heroku remote: git remote add heroku https://git.heroku.com/your-app-name.git
  4. Deploy: git push heroku main

Environment Variables

  • PORT: The port the server will listen on (provided by the hosting service)
  • HOST: Host address to bind to (default: '0.0.0.0')

Local Development

npm install
npm start

The server will run on port 1234 by default (or the PORT environment variable).

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors