Visão Geral do Frontend
Bem-vindo à documentação oficial do Frontend da Smart NX (SNX). Este espaço centraliza todo o conhecimento técnico, padrões de engenharia e boas práticas adotadas na construção das interfaces da plataforma Smart NX — desde arquitetura até observabilidade e experiência do desenvolvedor.
Nosso objetivo é garantir que o frontend da SNX seja moderno, coeso, performático e escalável, apoiando o crescimento do produto e a excelência técnica da engenharia.
O que você encontrará aqui
- Arquitetura — princípios, estrutura de pastas e convenções.
- Processos de Desenvolvimento — planning, branching (history/) e workflow de PRs.
- Setup de ambiente — instalação, variáveis e build pipeline.
- Design de Interfaces — tokens, temas e guidelines visuais.
- Padrões de desenvolvimento — hooks, contextos, rotas e testes.
- Boas práticas — performance, acessibilidade e segurança.
- Contribuição — diretrizes para evolução contínua da base de código e documentação.
Contribuindo
A documentação e o código do frontend são vivos e colaborativos. Qualquer membro pode propor melhorias, correções ou novas seções.
- Toda contribuição deve seguir o padrão de commits e PRs definidos no Guia de Contribuição.
- As alterações devem prezar pela clareza, consistência e atualização contínua da base de conhecimento.
Consulte o Guia de Contribuição → para conhecer o processo completo de escrita, revisão e versionamento.
Objetivo da Documentação
Servir como fonte única de verdade (Single Source of Truth) para o frontend da Smart NX, consolidando práticas de engenharia, design system, observabilidade e contribuição. Nosso propósito é permitir que qualquer pessoa do time consiga entender, evoluir e entregar valor com consistência, mantendo o alto padrão técnico da organização.
Histórico de Versões
| Data | Versão | Autor / Revisor | Alterações |
|---|---|---|---|
| 08/04/2026 | v1.2.0 | Juathan Coelho Duarte | Inclusão do Processo de Desenvolvimento na visão geral |
| 08/04/2026 | v1.1.0 | Juathan Coelho Duarte | Alterações de processos e padrões |
| 29/10/2025 | v1.0.0 | @Matheus Telles | Criação inicial e estrutura base do documento |