79 lines
3.0 KiB
Markdown
79 lines
3.0 KiB
Markdown
# SPORE UI Documentation
|
|
|
|
This directory contains detailed documentation for the SPORE UI frontend application.
|
|
|
|
## Documentation Index
|
|
|
|
### Core Documentation
|
|
|
|
- **[Framework](./FRAMEWORK_README.md)**: Component-based architecture, View Models, Event Bus, and framework conventions
|
|
- **[Discovery](./DISCOVERY.md)**: Node discovery system and cluster management
|
|
- **[Topology WebSocket Update](./TOPOLOGY_WEBSOCKET_UPDATE.md)**: Real-time topology visualization updates
|
|
- **[Logging](./LOGGING.md)**: Logging system and debugging utilities
|
|
|
|
### Feature Documentation
|
|
|
|
- **[Events](./Events.md)**: Real-time WebSocket event visualization with interactive force-directed graph
|
|
- **[Firmware Registry Integration](./FIRMWARE_REGISTRY_INTEGRATION.md)**: 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](./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](./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](./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](./TOPOLOGY_WEBSOCKET_UPDATE.md) for detailed documentation.
|
|
|
|
## Quick Reference
|
|
|
|
### Most Popular Pages
|
|
1. [Framework Architecture](./FRAMEWORK_README.md) - Start here for understanding the codebase
|
|
2. [Events Feature](./Events.md) - Real-time event visualization
|
|
3. [Firmware Registry Integration](./FIRMWARE_REGISTRY_INTEGRATION.md) - Firmware management
|
|
|
|
### Developer Resources
|
|
- Component development: See [FRAMEWORK_README.md](./FRAMEWORK_README.md)
|
|
- Debugging: See [LOGGING.md](./LOGGING.md)
|
|
- Testing: See individual component documentation
|
|
|
|
## Contributing
|
|
|
|
When adding new features or documentation:
|
|
1. Follow the existing documentation structure
|
|
2. Include code examples and diagrams where helpful
|
|
3. Update this README when adding new documentation files
|
|
4. 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`
|
|
|