ArqSystemSistema de Gestão Arquivística

O que é ArqSystem? ​

ArqSystem é um sistema completo de gestão arquivística desenvolvido seguindo as normas do CONARQ (Conselho Nacional de Arquivos). O sistema oferece gerenciamento de documentos, upload de PDFs com processamento automático, busca full-text avançada e campos totalmente dinâmicos.

Características Principais ​

• ✅ Conformidade CONARQ: Níveis de acesso padronizados (Público, Restrito, Confidencial, Secreto)
• ✅ Upload Inteligente: PDFs são automaticamente processados com extração de páginas e conversão WebP
• ✅ Busca Rápida: Motor Sonic proporciona busca em sub-milissegundo com tolerância a erros
• ✅ Zero Downtime: Adicione novos campos sem código ou deployment
• ✅ Type-Safe: TypeScript end-to-end com tRPC para comunicação cliente-servidor
• ✅ Auditoria Completa: Registro de todas as operações com mudanças campo a campo

Stack Tecnológica ​

Frontend ​

• Next.js 14 - Framework React
• TanStack Router - Routing type-safe
• TanStack Query - Data fetching e cache
• shadcn/ui - Componentes UI
• Tailwind CSS - Estilização

Backend ​

• Express.js - Web framework
• tRPC - Type-safe API
• Prisma - ORM
• PostgreSQL - Banco de dados
• BullMQ + Redis - Background jobs
• Sonic - Motor de busca

Storage ​

• Cloudflare R2 - Object storage S3-compatible
• Sharp - Processamento de imagens
• pdftoppm - Extração de páginas de PDF

Principais Funcionalidades ​

1. Dashboard ​

Visão geral do sistema com:

• Cards de métricas configuráveis (total, recentes)
• Listagem dos últimos documentos cadastrados
• Indicadores de conformidade CONARQ
• Acesso público (apenas docs públicos) e autenticado

2. Gestão de Documentos ​

• Criar: Formulário dinâmico com campos configuráveis
• Visualizar: Exibição completa de todos os campos e anexos
• Editar: Atualização com registro de auditoria
• Excluir: Soft delete com rastreamento

3. Upload de PDFs ​

• Upload direto para Cloudflare R2 (sem passar pelo servidor)
• Processamento assíncrono em background
• Extração automática de páginas
• Conversão para formato WebP otimizado
• Criação automática de documento pré-preenchido

4. Busca Avançada ​

• Busca full-text em todos os campos
• Tolerância a erros de digitação (fuzzy search)
• Sugestões automáticas de busca
• Resultados ordenados por relevância
• Combinação com filtros (tipo, acesso, data)

5. Campos Dinâmicos ​

• Criar campos personalizados via interface
• 6 tipos de campo (TEXT, TEXTAREA, NUMBER, DATE, SELECT, BOOLEAN)
• Validações configuráveis (tamanho, padrão, opções)
• Organização em seções
• Controle de visibilidade e obrigatoriedade

6. Auditoria ​

• Registro de todas as operações
• Mudanças campo a campo
• Usuário e timestamp
• Histórico completo por documento
• Relatórios de atividade

Conformidade CONARQ ​

O sistema implementa os 4 níveis de acesso do CONARQ:

🟢 Público ​

Acessível a todos, incluindo visitantes não autenticados.

🟡 Restrito ​

Visível apenas para usuários autenticados com permissão.

🟠 Confidencial ​

Acesso com autorização específica. Documentos sensíveis.

🔴 Secreto ​

Máximo nível de restrição. Auditoria de todos os acessos.

Começar Agora ​

Instalação Rápida ​

# Clone o repositório
git clone https://github.com/giovanifranz/arq-system.git
cd arq-system

# Configure variáveis de ambiente
cp .env.example .env

# Inicie com Docker
docker-compose up -d

# Instale dependências
pnpm install

# Execute migrações e seeds
cd packages/db
pnpm prisma migrate deploy
pnpm db:seed

# Inicie o sistema
pnpm dev

Acesse:

• Frontend: http://localhost:3000
• API: http://localhost:4000

Próximos Passos ​

1. Instalar e configurar
2. Configurar parâmetros do sistema
3. Criar primeiro documento
4. Testar upload de PDFs
5. Configurar busca

Documentação ​

• Guia do Usuário - Como usar o sistema
• API Reference - Documentação completa da API
• Arquitetura - Visão técnica do sistema

Licença ​

Este projeto está licenciado sob a licença MIT.

Desenvolvido para facilitar a gestão arquivística seguindo as normas CONARQ.