Studio de código aberto
O Dashboard Studio oferece uma opção de código aberto (licença MPL-2.0) para equipes técnicas que precisam de personalização do frontend além da configuração padrão. Modifique a interface do usuário, integre com aplicações existentes ou implemente sistemas de design personalizados mantendo todas as capacidades de análise.
Casos de uso
Cenários comuns em que a abordagem de código aberto pode ser útil:
Branding personalizado e integração de sistema de design
Fluxos de UI especializados por setor
Análises incorporadas em aplicações proprietárias
Implementações white-label para parceiros
Pré-requisitos
Acesso ao IoT Query
Instância ativa com credenciais válidas de banco de dados
Autenticação
Token JWT do Navixy Authentication Gateway
Ambiente de desenvolvimento
Node.js 18+, npm, Git
Habilidades técnicas
React, TypeScript, PostgreSQL, desenvolvimento web moderno
Consulte App Connect na nossa documentação para desenvolvedores para detalhes de implementação de autenticação.
Componentes de código aberto
A implementação de código aberto do Dashboard Studio consiste em três componentes principais:
Repositório GitHub
Localização: https://github.com/SquareGPS/navixy-iot-query-dashboard
O repositório contém a aplicação frontend completa em React, serviços backend em Node.js, arquivos de configuração e documentação abrangente. Clone o repositório para desenvolvimento local ou para revisar a arquitetura antes da implementação.
pacote npm
Distribuição otimizada para integração em projetos JavaScript. O pacote espelha a base de código do GitHub com o fluxo de instalação padrão via npm. Consulte o repositório README para instruções de instalação e versionamento.
Gateway de autenticação
Geração de token JWT através do gateway de autenticação Navixy. O backend gerencia a sessão de forma transparente. Consulte App Connect na nossa documentação para desenvolvedores para detalhes de implementação.
Primeiros passos
Etapas de configuração:
Revise o repositório README
Certifique-se de que você tenha acesso ativo ao IoT Query
Instale Node.js 18+ e npm
Siga o Guia de Início Rápido do repositório para implantação local
Revise a documentação de arquitetura antes de customizar
Documentação no repositório
O repositório inclui guias abrangentes para trabalhar com a base de código:
Design do sistema, estrutura de componentes, fluxo de dados
Configuração local, padrões de codificação, testes, fluxos de trabalho
Endpoints do backend, formatos de requisição/resposta, autenticação
Hospedagem em produção para vários ambientes
Todos os arquivos de documentação estão localizados na pasta /docs do repositório. A base de código usa TypeScript em todo o projeto para segurança de tipos e interfaces de componente claras.
Opções de customização
A implementação de código aberto fornece acesso completo ao frontend para modificações:
UI e design
Biblioteca de componentes (cores, tipografia, espaçamento, padrões de UI)
Integração de sistema de design personalizado
Modificações de tema
Editor de painéis
Algoritmos de layout personalizados
Métodos alternativos de organização de painéis
Fluxos de trabalho simplificados para grupos de usuários específicos
Visualizações
Substitua componentes de gráfico existentes por personalizados
Adicione novos tipos de visualização
Modifique o comportamento de renderização dos gráficos
Integração
Implementação de single sign-on
Navegação compartilhada com aplicações existentes
Visualizações de análises incorporadas
Revise a ARCHITECTURE.md arquivo no repositório antes de modificações significativas para entender os relacionamentos entre componentes e as mudanças necessárias.
Paridade de recursos com a versão padrão
O Dashboard Studio de código aberto mantém paridade completa de recursos com a versão hospedada pela Navixy:
Editor de painéis (arrastar e soltar, painéis, linhas)
✓
✓
Execução de SQL (segurança, timeouts, cache)
✓
✓
Visualizações (barra, pizza, tabela, estatística)
✓
✓
Organização do menu (seções, reordenação)
✓
✓
Atualizações e novos recursos
✓
✓
O repositório recebe atualizações regulares alinhadas com os lançamentos da versão hospedada. Novos tipos de visualização, capacidades do editor e melhorias de desempenho aparecem em ambos os modelos de implantação simultaneamente.
Modelo de suporte e manutenção
Atualizações principais do Dashboard Studio
✓
Correções de segurança
✓
Compatibilidade com a API IoT Query
✓
Atualizações de documentação
✓
Manutenção de código personalizado
✓
Infraestrutura de implantação
✓
Sincronização com o upstream
✓
Testes após atualizações
✓
Monitore o repositório por releases que contenham correções de bugs, patches de segurança e recursos. Teste suas customizações após as atualizações antes de implantar em produção.
Suporte e assistência
Para suporte técnico e assistência com o IoT Query, entre em contato com nossa equipe de suporte em [email protected].
Atualizado
Isto foi útil?