Skip to main content

Real-Time Updates Documentation

WebSocket-based real-time features for live updates across the CivStart platform.

Documentation Files​

ENHANCEMENT_PLAN.md​

Overall roadmap and plan for real-time features including:

  • Feature requirements
  • Technical approach
  • Implementation phases
  • Success metrics

PHASE_1_2_SUMMARY.md​

Summary of Phase 1-2 implementation:

  • WebSocket infrastructure setup
  • Basic real-time events
  • Client connection management
  • Admin portal integration

PHASE_3_SUMMARY.md​

Summary of Phase 3 implementation:

  • Advanced event types
  • Signal pool real-time updates
  • Contact request notifications
  • Frontend client integration

PHASE_4_SUMMARY.md​

Summary of Phase 4 implementation:

  • Performance optimizations
  • Scalability improvements
  • Connection state management
  • UI/UX enhancements

Architecture​

The real-time system uses:

  • Socket.IO for WebSocket connections
  • Redis for pub/sub across instances
  • React hooks for client-side state management
  • Custom event system for typed event handling

Event Types​

  • signal:created - New signal added
  • signal:updated - Signal modified
  • signal:assigned - Signal assigned to startup
  • contactRequest:approved - Contact request approved
  • contactRequest:denied - Contact request denied
  • connection:created - New connection established
  • connection:updated - Connection status changed
  • assignment:created - New assignment created
  • metrics:updated - Dashboard metrics refreshed

Quick Start​

See ENHANCEMENT_PLAN.md for setup instructions and usage examples.