Documentação de uso (Arquivologia-TI)
Resumo
- Projeto: aplicação desktop híbrida (Electron + Vite + React).
- Frontend: Vite + React.
- Electron: código em electron/main.cjs.
- Build/empacotamento: configurações para electron-builder e Electron Forge presentes.
- Scripts principais disponíveis em package.json: electron, dev, build, preview, lint.
Requisitos
- Node.js (recomendado: 16+ ou 18). Use nvm para gerenciar versões.
- npm (>=6) ou yarn.
- Ferramentas de build do sistema (quando necessário para empacotamento em plataformas específicas).
Instalação
-
Clonar o repositório:
- git clone https://github.com/Matheusfbio/Arquivologia-TI.git
- cd Arquivologia-TI
-
Instalar dependências:
- npm install
- ou
- yarn install
Execução em desenvolvimento
-
Inicie o servidor de desenvolvimento do frontend (Vite):
- npm run dev
- ou
- yarn dev
- Isso inicia o servidor Vite (por padrão em http://localhost:5173, dependendo da configuração).
-
Em outro terminal, execute o Electron apontando para o projeto:
- npm run electron
- ou
- yarn electron
- Observação: o comando electron inicia a aplicação desktop; mantenha o servidor Vite rodando para desenvolvimento rápido com HMR.
Scripts disponíveis (package.json)
- npm run dev — inicia Vite em modo desenvolvimento (host público).
- npm run electron — inicia o processo Electron (com flags mostradas no script).
- npm run build — executa o build do Vite (gera /dist).
- npm run preview — preview do build do Vite (serve o conteúdo de production build localmente).
- npm run lint — executa ESLint para verificar problemas de código.
Build / Produção e empacotamento
-
Gerar arquivos da interface:
- npm run build
- Isso produz a pasta dist com os assets para a aplicação.
-
Empacotar/gerar instalador:
- O package.json contém configuração de build (appId, targets Windows NSIS, arquivos incluídos, diretórios).
- Opções comuns:
- Usar o utilitário de empacotamento configurado no projeto (por exemplo, executar o comando da sua ferramenta de empacotamento preferida no projeto). Ex.: npx electron-builder --win (ou comando equivalente configurado no fluxo de release).
- Ou usar a ferramenta de empacotamento/empacotador integrada (se houver um comando específico na sua configuração de CI/CD).
- As configurações indicam target NSIS para Windows e zip maker para pacotes via Forge.
Notas importantes para empacotamento:
- Certifique-se de que os arquivos listados em "files" (dist/**/*, electron/main.cjs, node_modules, package.json) existam antes de empacotar.
- Ajuste appId, nomes e diretórios de saída conforme necessário (configuração atual usa "realeses" para saída e "dist" como buildResources).
Estrutura recomendada (visão geral)
- electron/ — entrada do Electron (electron/main.cjs)
- src/ — código fonte React/Vite
- public/ — assets públicos
- dist/ — saída do build do Vite (gerado)
- package.json — scripts, dependências e configurações de build
Boas práticas e dicas
- Desenvolvimento: execute o servidor Vite e o Electron em terminais separados para aproveitar HMR.
- Antes do empacotamento, executar npm run build é necessário para ter os assets prontos.
- Verifique as versões de Node e dependências se ocorrerem erros de compatibilidade.
- Rodar lint regularmente: npm run lint.
- Teste em plataforma alvo (Windows/Linux/Mac) no ambiente final para validar behavior do instalador e permissões.
Solução de problemas comuns
- Erro ao iniciar o Electron: confira se o servidor Vite está rodando (se o Electron espera assets via localhost) ou se dist existe quando for inicio em modo produção.
- Problemas no empacotamento: confira logs do empacotador, caminhos listados em "files" e permissões de arquivo.
- Dependências faltando/erro de compilação: remover node_modules e lockfile e reinstalar pode corrigir: rm -rf node_modules package-lock.json yarn.lock && npm install
Considerações finais
- Dependências principais: react, react-dom, vite, electron, electron-builder, electron-forge (plugins).
- Ajuste as configurações de build (appId, output directory, targets) para refletir nome/assinatura desejada da aplicação.
- Se for publicar installer para Windows, valide NSIS settings e assine o build quando necessário.