Open-source Studio
Dashboard Studio provides open-source (MPL-2.0 license) option for technical teams that need frontend customization beyond standard configuration. Modify the UI, integrate with existing applications, or implement custom design systems while maintaining full analytics capabilities.
Use cases
Common scenarios, when open-source approach can be useful:
Custom branding and design system integration
Specialized industry-specific UI workflows
Embedded analytics in proprietary applications
White-label implementations for partners
Prerequisites
IoT Query access
Active instance with valid database credentials
Authentication
JWT token from Navixy Authentication Gateway
Development environment
Node.js 18+, npm, Git
Technical skills
React, TypeScript, PostgreSQL, modern web development
Open-source components
Dashboard Studio's open-source implementation consists of three main components:
GitHub repository
Location: https://github.com/SquareGPS/navixy-iot-query-dashboard
The repository contains the complete React frontend application, Node.js backend services, configuration files, and comprehensive documentation. Clone the repository for local development or to review the architecture before implementation.
npm package
Streamlined distribution for JavaScript project integration. The package mirrors the GitHub codebase with standard npm installation workflow. See the repository README for installation instructions and versioning.
Authentication gateway
JWT token generation through Navixy authentication gateway. Backend handles session management transparently. See Authentication Gateway in our developer documentation for implementation details.
Getting started
Setup steps:
Review the repository README
Make sureyou have active IoT Query access
Install Node.js 18+ and npm
Follow the repository Quick Start guide for local deployment
Review the architecture documentation before customizing
In-repo documentation
The repository includes comprehensive guides for working with the codebase:
System design, component structure, data flow
Local setup, coding standards, testing, workflows
Backend endpoints, request/response formats, authentication
Production hosting for various environments
All documentation files are located in the repository's /docs folder. The codebase uses TypeScript throughout for type safety and clear component interfaces.
Customization options
The open-source implementation provides full frontend access for modifications:
UI and design
Component library (colors, typography, spacing, UI patterns)
Custom design system integration
Theme modifications
Dashboard editor
Custom layout algorithms
Alternative panel arrangement methods
Simplified workflows for specific user groups
Visualizations
Replace existing chart components with custom ones
Add new visualization types
Modify chart rendering behavior
Integration
Single sign-on implementation
Shared navigation with existing applications
Embedded analytics views
Review the ARCHITECTURE.md file in the repository before significant modifications to understand component relationships and required changes.
Feature parity with standard version
Open-source Dashboard Studio maintains complete feature parity with the Navixy-hosted version:
Dashboard editor (drag-and-drop, panels, rows)
✓
✓
SQL execution (security, timeouts, caching)
✓
✓
Visualizations (bar, pie, table, stat)
✓
✓
Menu organization (sections, reordering)
✓
✓
Updates and new features
✓
✓
The repository receives regular updates aligned with hosted version releases. New visualization types, editor capabilities, and performance improvements appear in both deployment models simultaneously.
Support and maintenance model
Core Dashboard Studio updates
✓
Security patches
✓
IoT Query API compatibility
✓
Documentation updates
✓
Custom code maintenance
✓
Deployment infrastructure
✓
Synchronization with upstream
✓
Testing after updates
✓
Monitor the repository for releases containing bug fixes, security patches, and features. Test your customizations after updates before deploying to production.
Support and assistance
For technical support and assistance with IoT Query, contact our support team at [email protected].
Last updated
Was this helpful?