Introdução ao ArqSystem
Bem-vindo à documentação do ArqSystem, um sistema completo de gestão arquivística desenvolvido seguindo as normas do CONARQ (Conselho Nacional de Arquivos).
O que é ArqSystem?
ArqSystem é uma plataforma moderna e completa para digitalização, organização e gerenciamento de documentos arquivísticos. O sistema foi projetado para atender às necessidades de órgãos públicos, arquivos históricos e empresas que precisam de uma solução robusta para gestão documental.
Principais Características
🎯 Conformidade CONARQ
O sistema implementa fielmente os padrões do CONARQ, incluindo:
- 4 níveis de acesso padronizados (Público, Restrito, Confidencial, Secreto)
- Metadados obrigatórios conforme normas arquivísticas
- Classificação e temporalidade de documentos
- Auditoria completa de todas as operações
📄 Gestão Completa de Documentos
- CRUD Completo: Criar, visualizar, editar e excluir documentos
- Campos Dinâmicos: Configure novos campos sem necessidade de código
- Formulários Inteligentes: Interface adaptativa baseada nas configurações
- Soft Delete: Exclusão lógica com preservação de histórico
📤 Upload Avançado de PDFs
- Upload Direto: Envio para cloud storage sem passar pelo servidor
- Processamento Assíncrono: Extração de páginas em background
- Conversão WebP: Otimização automática de imagens
- Vinculação Automática: PDFs vinculados automaticamente aos documentos
🔍 Busca Full-Text Poderosa
- Sonic Search Engine: Busca em sub-milissegundo
- Fuzzy Matching: Tolerância a erros de digitação
- Sugestões Automáticas: Autocomplete inteligente
- Busca Multilíngue: Suporte a português com tokenização adequada
⚙️ Sistema de Campos 100% Dinâmico
- Zero Downtime: Adicione campos sem código ou deployment
- 6 Tipos de Campo: TEXT, TEXTAREA, NUMBER, DATE, SELECT, BOOLEAN
- Validações Flexíveis: Configure regras de validação por campo
- Organização em Seções: Agrupe campos logicamente
📊 Auditoria Detalhada
- Registro Completo: Todas as operações são auditadas
- Mudanças Campo a Campo: Comparação old value vs new value
- Rastreamento de Usuário: Quem fez cada alteração
- Timeline de Eventos: Histórico completo por documento
Tecnologias Utilizadas
Frontend
- React 19 com TypeScript
- TanStack Router para routing type-safe
- TanStack Query para data fetching e cache
- shadcn/ui para componentes UI
- Tailwind CSS para estilização
Backend
- Node.js com Express
- tRPC para API type-safe
- Prisma ORM com PostgreSQL
- BullMQ + Redis para background jobs
- Sonic para busca full-text
Storage
- Cloudflare R2 (S3-compatible)
- Sharp para processamento de imagens
- pdftoppm para extração de páginas PDF
Arquitetura
O ArqSystem segue uma arquitetura moderna e escalável:
┌─────────────────┐
│ Frontend │ React + TanStack
│ (Web App) │ shadcn/ui + Tailwind
└────────┬────────┘
│
│ tRPC (Type-safe)
│
┌────────▼────────┐
│ Backend │ Express + tRPC
│ (API Server) │ Prisma ORM
└────────┬────────┘
│
┌────┴─────────────────┐
│ │
┌───▼──────┐ ┌───────▼────┐
│ PostgreSQL│ │ Redis │
│ (Database)│ │ (Cache) │
└───────────┘ └────────────┘
│
┌──────▼──────┐
│ BullMQ │
│ (Jobs) │
└──────┬──────┘
│
┌────────────────┴─────────────┐
│ │
┌────▼─────┐ ┌────────▼────┐
│ Sonic │ │ R2 │
│ (Search) │ │ (Storage) │
└──────────┘ └─────────────┘Casos de Uso
Órgãos Públicos
- Gestão de processos administrativos
- Organização por hierarquia governamental (Federal/Estadual/Municipal)
- Transparência e acesso público a documentos
- Conformidade com Lei de Acesso à Informação
Arquivos Históricos
- Digitalização de acervos
- Catalogação de documentos históricos
- Disponibilização para pesquisadores
- Preservação digital do patrimônio
Empresas Privadas
- Gestão de contratos e documentos legais
- Arquivo de documentos corporativos
- Controle de acesso a informações sensíveis
- Auditoria para compliance
Por Onde Começar?
- Instalação - Configure o ambiente de desenvolvimento
- Configuração - Configure os parâmetros do sistema
- Gestão de Documentos - Aprenda a criar e gerenciar documentos
- Upload de PDFs - Entenda o sistema de upload
- Busca - Configure e use a busca full-text
Suporte e Comunidade
- Documentação: Você está aqui!
- Issues: GitHub Issues
- Código-fonte: GitHub Repository
Licença
Este projeto está licenciado sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.
Desenvolvido para facilitar a gestão arquivística seguindo as normas CONARQ.