Studio open-source

Dashboard Studio propose une option open-source (licence MPL-2.0) pour les équipes techniques qui ont besoin de personnaliser le frontend au-delà de la configuration standard. Modifiez l'interface utilisateur, intégrez-la aux applications existantes ou implémentez des systèmes de design personnalisés tout en conservant l'intégralité des capacités analytiques.

Cas d'utilisation

Scénarios courants où l'approche open-source peut être utile :

• Personnalisation de l'identité visuelle et intégration du système de design

• Flux d'interface utilisateur spécialisés par secteur

• Analytique intégrée dans des applications propriétaires

• Implémentations en marque blanche pour des partenaires

Prérequis

Composant	Exigence
Accès IoT Query	Instance active avec identifiants de base de données valides
Authentification	Jeton JWT provenant de la passerelle d'authentification Navixy
Environnement de développement	Node.js 18+, npm, Git
Compétences techniques	React, TypeScript, PostgreSQL, développement web moderne

Voir App Connect dans notre documentation développeur pour les détails d'implémentation de l'authentification.

Composants open-source

L'implémentation open-source de Dashboard Studio se compose de trois composants principaux :

Dépôt GitHub

Emplacement : https://github.com/SquareGPS/navixy-iot-query-dashboard

Le dépôt contient l'application frontend React complète, les services backend Node.js, les fichiers de configuration et une documentation complète. Clonez le dépôt pour le développement local ou pour examiner l'architecture avant l'implémentation.

Package npm

Distribution simplifiée pour l'intégration dans des projets JavaScript. Le package reflète la base de code GitHub avec le flux d'installation npm standard. Voir le dépôt README pour les instructions d'installation et la gestion des versions.

Passerelle d'authentification

Génération de jetons JWT via la passerelle d'authentification Navixy. Le backend gère la gestion des sessions de manière transparente. Voir App Connect dans notre documentation développeur pour les détails d'implémentation.

Premiers pas

Étapes de configuration :

1. Passez en revue le dépôt README

2. Assurez-vous que vous disposez d'un accès IoT Query actif

3. Installez Node.js 18+ et npm

4. Suivez le Guide de démarrage rapide du dépôt pour le déploiement local

5. Consultez la documentation d'architecture avant de personnaliser

Documentation dans le dépôt

Le dépôt inclut des guides complets pour travailler avec la base de code :

Document	Contenu
ARCHITECTURE.md	Conception du système, structure des composants, flux de données
DEVELOPMENT.md	Configuration locale, normes de codage, tests, workflows
API.md	Points de terminaison backend, formats de requête/réponse, authentification
DEPLOYMENT.md	Hébergement en production pour différents environnements

Tous les fichiers de documentation se trouvent dans le dossier /docs du dépôt. La base de code utilise TypeScript partout pour la sûreté des types et des interfaces de composants claires.

Options de personnalisation

L'implémentation open-source fournit un accès complet au frontend pour les modifications :

UI et design

• Bibliothèque de composants (couleurs, typographie, espacements, modèles d'interface)

• Intégration d'un système de design personnalisé

• Modifications du thème

Éditeur de tableau de bord

• Algorithmes de mise en page personnalisés

• Méthodes alternatives d'agencement des panneaux

• Flux de travail simplifiés pour des groupes d'utilisateurs spécifiques

Visualisations

• Remplacer les composants de graphique existants par des composants personnalisés

• Ajouter de nouveaux types de visualisation

• Modifier le comportement de rendu des graphiques

Intégration

• Implémentation de l'authentification unique

• Navigation partagée avec des applications existantes

• Vues d'analytique intégrées

Consultez la ARCHITECTURE.md fichier dans le dépôt avant des modifications significatives pour comprendre les relations entre composants et les changements requis.

Parité fonctionnelle avec la version standard

Dashboard Studio open-source maintient une parité complète des fonctionnalités avec la version hébergée par Navixy :

Fonctionnalité	Open-source	Standard
Éditeur de tableau de bord (glisser-déposer, panneaux, lignes)	✓	✓
Exécution SQL (sécurité, délais d'attente, mise en cache)	✓	✓
Visualisations (barres, camembert, tableau, statistique)	✓	✓
Organisation du menu (sections, réordonnancement)	✓	✓
Mises à jour et nouvelles fonctionnalités	✓	✓

Le dépôt reçoit des mises à jour régulières alignées sur les versions de la version hébergée. De nouveaux types de visualisation, des capacités de l'éditeur et des améliorations de performance apparaissent simultanément dans les deux modèles de déploiement.

Modèle de support et de maintenance

Responsabilité	Votre équipe	Navixy
Mises à jour du cœur de Dashboard Studio		✓
Correctifs de sécurité		✓
Compatibilité API IoT Query		✓
Mises à jour de la documentation		✓
Maintenance du code personnalisé	✓
Infrastructure de déploiement	✓
Synchronisation avec l'amont	✓
Tests après les mises à jour	✓

Surveillez le dépôt pour les versions contenant des corrections de bugs, des correctifs de sécurité et des fonctionnalités. Testez vos personnalisations après les mises à jour avant de déployer en production.

Support et assistance

Pour le support technique et l'assistance concernant IoT Query, contactez notre équipe de support à [email protected].