WorkspaceCraft

A self-hosted virtual office platform for remote teams. Like Minecraft, but for collaborative workspaces.

Features (Planned)

MVP (Phase 1)

• 3D workspace with avatar movement
• Self-hosted server deployment via Docker
• Real-time multiplayer
• Text chat
• Basic room system

Phase 2

• Proximity-based voice chat
• Screen sharing capabilities
• Meeting rooms with scheduling
• Collaborative whiteboards
• Presence indicators

Phase 3

• Customizable office spaces
• Admin dashboard
• Performance optimizations
• Mobile support

Tech Stack

Server

• Node.js + TypeScript
• Express.js for REST API
• Socket.io for WebSocket communication
• PostgreSQL for persistent data
• Redis for real-time state management

Client

• React + TypeScript
• Three.js for 3D rendering
• Vite for build tooling
• WebRTC for voice/video

Deployment

• Docker + Docker Compose
• Nginx for reverse proxy

Quick Start

Prerequisites

• Node.js 18+
• Docker & Docker Compose
• PostgreSQL (or use Docker)

Development

# Install dependencies
npm install

# Run in development mode (both client and server)
npm run dev

# Run server only
npm run dev:server

# Run client only
npm run dev:client

Production Deployment

# Start with Docker Compose
npm run docker:up

# Stop
npm run docker:down

See DEPLOYMENT.md for detailed deployment instructions.

Project Structure

workspacecraft/
├── server/          # Backend server
├── client/          # Frontend application
├── shared/          # Shared TypeScript types
├── deployment/      # Docker and deployment configs
└── docs/            # Documentation

Documentation

• Architecture Overview
• API Documentation
• Deployment Guide

License

MIT

Contributing

Contributions welcome! Please read our contributing guidelines before submitting PRs.