Quem trabalha com aplicações Ruby on Rails sabe que, conforme o projeto cresce, entender rapidamente as relações entre modelos pode se tornar cada vez mais difícil.
Mesmo utilizando ferramentas tradicionais de geração de ERD (Entity Relationship Diagram), normalmente existe um pequeno atrito no fluxo: gerar arquivos, atualizar diagramas manualmente ou depender de processos externos.
Pensando nisso, criei a gem Rails Realtime ERD.
O que é o Rails Realtime ERD?
O rails-realtime-erd é uma gem para Ruby on Rails que permite visualizar diagramas ERD do seu schema em tempo real diretamente dentro da aplicação.
A proposta é simples:
- Instalar a gem
- Montar a engine no projeto
- Abrir uma rota
- Ver seu diagrama atualizado automaticamente
Sem geração manual de imagens. Sem exportações intermediárias. Sem sair do contexto da aplicação.
Principais recursos
- ✅ Visualização do schema em tempo real
- ✅ Integração simples com aplicações Rails
- ✅ Baseado em Rails Engine
- ✅ Atualizações automáticas conforme seus models evoluem
- ✅ Interface web integrada ao projeto
Ideal para:
- Entender arquiteturas existentes
- Onboarding de novos desenvolvedores
- Exploração rápida de relacionamentos entre modelos
- Documentação viva do domínio da aplicação
Instalação
Adicione a gem ao seu Gemfile:
gem "rails-realtime-erd"
Depois:
bundle install
Agora basta acessar
/rails/erd
em seu projeto e visualizar seu diagrama.
Por que criar essa gem?
Durante consultorias, cursos e desenvolvimento de aplicações Rails, frequentemente senti falta de uma experiência mais dinâmica para inspeção do domínio da aplicação.
Queria algo próximo da experiência que temos com:
/rails/mailers/sidekiq- dashboards internos
- ferramentas de desenvolvimento integradas
Ou seja: abrir uma URL e começar a explorar imediatamente.
Foi daí que nasceu o Rails Realtime ERD.
Projeto Open Source
A gem é open source e está disponível no GitHub:
Contribuições, feedbacks, issues e sugestões são muito bem-vindos.
Se você trabalha com Rails e gosta de ferramentas para melhorar produtividade e entendimento de arquitetura, vale a pena experimentar.