Welcome to the Meshtastic Node Mapper documentation. Whether you're a user wanting to monitor your mesh network or a developer looking to contribute, you'll find everything you need here.
Perfect for anyone who wants to install, configure, and use the application.
- Installation Guide - Step-by-step setup instructions
- Features Overview - Visual tour of all features with screenshots
- User Guide - Complete feature walkthrough and how-to guides
- Troubleshooting - Solutions to common problems
- RF Link Visualization - Real-time network topology and RF connections
- Theme Customization - Light/dark/auto theme support
- Mobile Usage Guide - Mobile-optimized interface and features
- Dashboard Analytics - Comprehensive network insights and metrics
- Deployment Guide - Deploy and configure new features
- Production Deployment - Deploy on port 80 for production use
- Production Quick Start - Fast production deployment reference
- API Guide - REST API and WebSocket documentation for integrations
For developers who want to contribute, extend, or understand the codebase.
- Developer Hub - Main developer documentation index
- Architecture Overview - System design and technical details
- Contributing Guidelines - How to contribute to the project
- Development Setup - Set up your dev environment
- Implementation Guides - Detailed technical implementation documentation
...install and use the application
- Follow the Installation Guide
- Read the User Guide
- Check Troubleshooting if you have issues
Deploy to production
- Review Production Deployment
- Use the Production Quick Start
- Set up monitoring and backups
...integrate with the API
- Read the API Guide
- Review authentication methods
- Test with the interactive API docs
...contribute to development
- Read Contributing Guidelines
- Set up your Development Environment
- Review the Architecture
- Check out Good First Issues
A comprehensive web-based application for visualizing, monitoring, and analyzing Meshtastic mesh networks through real-time MQTT data.
For Network Operators:
- 📍 Interactive map with real-time node visualization
- 📊 Network analytics and performance monitoring
- 🗺️ Coverage analysis and planning tools
- 📱 Mobile-friendly with offline capabilities
- 🌐 Multi-network management
For Developers:
- 🔌 RESTful API with WebSocket support
- 🐳 Docker-based deployment
- 📚 Comprehensive documentation
- 🧪 Full test coverage
- 🔧 Extensible architecture
- Frontend: React 18+ with TypeScript, Material-UI, Leaflet maps
- Backend: Node.js with Express, Socket.IO for real-time updates
- Database: PostgreSQL 15+ with TimescaleDB for time-series data
- Cache: Redis for performance optimization
- MQTT: Mosquitto broker integration
- Deployment: Docker with multi-stage builds
- Docker: Version 20.10 or higher
- Docker Compose: Version 2.0 or higher
- RAM: 4 GB minimum (8 GB recommended)
- Storage: 20 GB minimum (50 GB recommended)
- OS: Linux, macOS, or Windows with Docker
- Node.js: Version 18.0 or higher
- npm: Version 8.0 or higher
- Git: Latest version
- IDE: VS Code recommended
- All user requirements above
- Documentation: Start with the User Guide
- Issues: Report problems on GitHub Issues
- Community: Ask questions in GitHub Discussions
- Developer Docs: See the Developer Hub
- API Reference: Check the API Guide
- Contributing: Read Contributing Guidelines
- Code Review: Submit Pull Requests
This project is licensed under the GNU General Public License v3.0 (GPL-3.0). See the LICENSE file for details.
- Current Version: 1.0.0
- Release Date: December 2024
- Meshtastic Compatibility: Firmware 2.0+
- Node.js: 18.0+ required
- Docker: 20.10+ required
New to the project? Start with the Installation Guide or User Guide.
Want to contribute? Check out the Developer Documentation.