For the complete documentation index, see llms.txt. This page is also available as Markdown.

Open-source Studio

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, integre com aplicativos existentes ou implemente sistemas de design personalizados, mantendo todos os recursos analíticos.

Casos de uso

Cenários comuns em que a abordagem de código aberto pode ser útil:

  • Branding personalizado e integração com sistema de design

  • Fluxos de trabalho de interface especializados por setor

  • Análises incorporadas em aplicativos proprietários

  • Implementações white-label para parceiros

Pré-requisitos

Componente
Requisito

Acesso ao IoT Query

Instância ativa com credenciais válidas do 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

Veja App Connect em nossa documentação de desenvolvedor para detalhes de implementação da 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, os serviços backend em Node.js, os 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 simplificada para integração em projetos JavaScript. O pacote espelha a base de código do GitHub com o fluxo padrão de instalação do npm. Veja o repositório README para instruções de instalação e versionamento.

Gateway de autenticação

Geração de token JWT por meio do gateway de autenticação da Navixy. O backend gerencia a sessão de forma transparente. Veja App Connect em nossa documentação de desenvolvedor para detalhes de implementação.

Primeiros passos

Etapas de configuração:

  1. Revise o repositório README

  2. Certifique-se de que você tem acesso ativo ao IoT Query

  3. Instale o Node.js 18+ e o npm

  4. Siga o guia Início rápido do repositório para implantação local

  5. Revise a documentação da arquitetura antes de personalizar

Documentação no repositório

O repositório inclui guias abrangentes para trabalhar com a base de código:

Documento
Conteúdo

Design do sistema, estrutura dos componentes, fluxo de dados

Configuração local, padrões de codificação, testes, fluxos de trabalho

Endpoints de 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 toda a sua extensão para garantir segurança de tipos e interfaces de componentes claras.

Opções de personalização

A implementação de código aberto oferece acesso completo ao frontend para modificações:

Interface e design

  • Biblioteca de componentes (cores, tipografia, espaçamento, padrões de interface)

  • Integração com sistema de design personalizado

  • Modificações de tema

Editor do painel

  • Algoritmos de layout personalizados

  • Métodos alternativos de organização dos painéis

  • Fluxos de trabalho simplificados para grupos específicos de usuários

Visualizações

  • Substitua os componentes de gráfico existentes por componentes personalizados

  • Adicione novos tipos de visualização

  • Modifique o comportamento de renderização dos gráficos

Integração

  • Implementação de login único

  • Navegação compartilhada com aplicativos existentes

  • Visões de análises incorporadas

Revise a ARCHITECTURE.md arquivo no repositório antes de modificações significativas para entender as relações entre os componentes e as alterações 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:

Recurso
Código aberto
Padrão

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 aos lançamentos da versão hospedada. Novos tipos de visualização, recursos do editor e melhorias de desempenho aparecem simultaneamente nos dois modelos de implantação.

Modelo de suporte e manutenção

Responsabilidade
Sua equipe
Navixy

Atualizações principais do Dashboard Studio

Correções de segurança

Compatibilidade com a API do IoT Query

Atualizações da documentação

Manutenção do código personalizado

Infraestrutura de implantação

Sincronização com a versão upstream

Testes após as atualizações

Monitore o repositório em busca de versões que contenham correções de bugs, patches de segurança e novos recursos. Teste suas personalizações após as atualizações antes de implantá-las 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 iotquery@navixy.com.

Atualizado

Isto foi útil?