SPORE UI Documentation
This directory contains detailed documentation for the SPORE UI frontend application.
Documentation Index
Core Documentation
- Framework: Component-based architecture, View Models, Event Bus, and framework conventions
- Discovery: Node discovery system and cluster management
- Topology WebSocket Update: Real-time topology visualization updates
- Logging: Logging system and debugging utilities
Feature Documentation
- Events: Real-time WebSocket event visualization with interactive force-directed graph
- Firmware Registry Integration: Integration with the firmware registry system
Feature Overview
Events Feature
The Events feature provides real-time visualization of WebSocket events streaming through the SPORE cluster. It displays events as an interactive force-directed graph, showing the flow and relationships between different event topics.
Key Capabilities:
- Real-time event tracking and visualization
- Interactive force-directed graph layout
- Event counting and frequency visualization
- Animated event flow visualization
- Topic hierarchy display
See Events.md for complete documentation.
Framework Architecture
The SPORE UI uses a component-based architecture with:
- View Models for state management
- Components for UI rendering
- Event Bus for pub/sub communication
- API Client for backend integration
See FRAMEWORK_README.md for architecture details.
Discovery System
The discovery system enables automatic detection of SPORE nodes on the network, maintaining a real-time view of cluster members.
See DISCOVERY.md for implementation details.
Topology Visualization
The topology view provides an interactive network graph showing relationships between cluster nodes in real-time.
See TOPOLOGY_WEBSOCKET_UPDATE.md for detailed documentation.
Quick Reference
Most Popular Pages
- Framework Architecture - Start here for understanding the codebase
- Events Feature - Real-time event visualization
- Firmware Registry Integration - Firmware management
Developer Resources
- Component development: See FRAMEWORK_README.md
- Debugging: See LOGGING.md
- Testing: See individual component documentation
Contributing
When adding new features or documentation:
- Follow the existing documentation structure
- Include code examples and diagrams where helpful
- Update this README when adding new documentation files
- Maintain consistency with existing documentation style
Related Documentation
For information about other SPORE components:
- SPORE Gateway: See
spore-gateway/README.md - SPORE Registry: See
spore-registry/README.md - SPORE Embedded: See
spore/README.md