Home

DANFE Workspace

Central de documentação oficial

Um ambiente de trabalho para consultar, processar e organizar documentos fiscais no Windows.

O DANFE Workspace centraliza a consulta de NF-e, a geração de DANFEs em PDF, o processamento em lote e a organização dos documentos em um único aplicativo desktop. O projeto combina uma interface moderna com uma API local, histórico persistente e integrações opcionais para automatizar tarefas fiscais.

Plataforma: Windows x64 · Desktop: Tauri 2 + Rust · Interface: React 19 + TypeScript · API: Node.js 24 + Express · Dados: SQLite e SQL Server (opcional)

---

Comece por aqui

Quero...	Onde começar
Entender o aplicativo	Funcionalidades
Conhecer o fluxo de documentos	Como funciona
Preparar o ambiente de desenvolvimento	Desenvolvimento
Entender as integrações	Integrações
Saber como funcionam as atualizações	Versões e atualizações
Encontrar o código-fonte	Repositório no GitHub

Funcionalidades

Recurso	Descrição
Consulta de NF-e	Consulte documentos pela chave de acesso e visualize ou salve o DANFE em PDF.
Processamento em lote	Importe chaves por texto ou arquivo, selecione notas e acompanhe o progresso.
Histórico local	Registre documentos processados e evite downloads repetidos.
Gerenciador de arquivos	Localize, visualize e abra a pasta dos documentos gerados.
Layouts adicionais	Gere DANFE Simplificado, Etiqueta e Cupom Varejo a partir do XML disponível localmente.
Automação com SQL Server	Consulte notas da operação por meio da integração opcional com o banco de dados.
Captura de chaves	Utilize a extensão do navegador para identificar chaves de NF-e copiadas.
Experiência desktop	Interface com temas claro e escuro, bandeja do sistema, logs e atualização pelo aplicativo.

Como funciona

O fluxo básico reúne consulta, processamento e armazenamento:

flowchart TD
    A[Consulta manual, lote ou integração SQL Server] --> B[API local]
    B --> C[Consulta de NF-e]
    C --> D[PDF e dados do documento]
    D --> E[Arquivos organizados]
    D --> F[Histórico SQLite]
    E --> G[Visualização e download]
    E --> H{XML disponível?}
    H -->|Sim| I[Conversão para layouts adicionais]
    H -->|Não| J[Informar indisponibilidade do XML]

Loading

O aplicativo mantém os arquivos gerados e o histórico no computador. As consultas fiscais e a conversão de XML podem depender de serviços externos configurados. A integração com SQL Server depende do acesso à rede e ao banco de dados da operação.

Organização dos documentos

DANFE/
├── PDF/                 # DANFEs principais
├── .XML/                # XMLs de origem, quando disponíveis
├── .JSON/               # Respostas das consultas
└── .LAYOUTS/
    ├── simplificado/    # DANFE Simplificado
    ├── etiqueta/        # DANFE Etiqueta
    └── varejo/          # DANFE Cupom Varejo

Os layouts adicionais ficam vinculados ao DANFE principal no aplicativo. As pastas auxiliares são ocultas no Windows para manter a pasta de saída organizada.

Arquitetura

O projeto é composto por camadas com responsabilidades separadas:

Camada	Tecnologias e responsabilidade
Desktop	Tauri 2 e Rust: janela nativa e empacotamento para Windows.
Frontend	React 19 e TypeScript: interface, navegação e acompanhamento dos processos.
Backend	Node.js 24 e Express: API local, consultas, arquivos e automações.
Persistência	SQLite: histórico local; SQL Server: integração opcional com dados da operação.
Extensão	Manifest V3: captura de chaves no navegador.
Serviços externos	Consulta de NF-e e conversão de XML, conforme configuração.

Desenvolvimento

Para executar o projeto em ambiente de desenvolvimento, são utilizados Node.js 24, npm, pnpm e, para a janela nativa, Rust com toolchain MSVC e os pré-requisitos do Tauri para Windows.

Com as dependências instaladas e o arquivo BACKEND/.env configurado, execute em terminais separados:

Terminal 1 — API local

cd BACKEND
npm run dev

Terminal 2 — Interface

cd FRONTEND
pnpm dev

Serviço	Endereço de desenvolvimento
Interface web	http://127.0.0.1:5173
API local de desenvolvimento	http://127.0.0.1:3001
API do aplicativo instalado	http://127.0.0.1:3000

Atenção: as portas e os serviços de desenvolvimento são separados da instalação local do aplicativo.

Integrações

Consulta de NF-e: utiliza o serviço de consulta configurado no backend.

MeuDanfe: converte XML local em layouts adicionais mediante API key. A geração desses layouts não realiza busca externa por chave quando o XML não está disponível.

SQL Server: integração opcional para consultar documentos da operação, sujeita às credenciais e à conectividade do ambiente.

Navegador: extensão compatível com navegadores Chromium para captura de chaves de acesso.

Versões e atualizações

O aplicativo possui fluxo de empacotamento para Windows com instalador NSIS e assinatura de atualização (.sig). O processo de publicação é separado do uso cotidiano e depende das credenciais e da configuração do ambiente de release.

Segurança: arquivos .env, credentials.json, senhas, tokens e chaves privadas de assinatura não devem ser publicados no repositório nem incluídos inadvertidamente em distribuições.

Próximos guias da Wiki

Esta página é o ponto de entrada da documentação. A estrutura sugerida para as próximas páginas é:

1. Instalação e primeiros passos — requisitos, configuração inicial e uso.
2. Consulta e processamento em lote — entradas, seleção e interrupção.
3. Arquivos e layouts — armazenamento, visualização e conversões.
4. Configuração do backend — variáveis de ambiente e endpoints.
5. Integração com SQL Server — conexão, filtros e monitoramento.
6. Desenvolvimento e arquitetura — execução local e componentes.
7. Build e publicação — instalador, assinatura e updater.
8. Solução de problemas — falhas comuns e diagnóstico.

---

DANFE Workspace · Desenvolvido por z3rdev

Ver repositório · Abrir Issues