Rails 실시간 ERD: 레일스 스키마를 실시간으로 시각화

Source: Dev.to

개요

Rails Realtime ERD는 Ruby on Rails용 gem으로, 애플리케이션 내부에서 스키마 ERD 다이어그램을 실시간으로 시각화할 수 있게 해줍니다. 이미지 파일을 직접 만들거나 중간 단계로 내보내는 번거로움 없이, 애플리케이션 컨텍스트를 떠날 필요가 없습니다.

기능

• ✅ 실시간 스키마 시각화
• ✅ Rails 애플리케이션과의 간편한 통합
• ✅ Rails 엔진 기반
• ✅ 모델이 변화함에 따라 자동 업데이트
• ✅ 통합 웹 인터페이스

다음에 적합합니다:

• 기존 아키텍처 이해
• 신입 개발자 온보딩
• 모델 관계를 빠르게 탐색
• 애플리케이션 도메인의 살아있는 문서 유지

설치

Gemfile에 gem을 추가하세요:

gem "rails-realtime-erd"

그런 다음 실행합니다:

bundle install

사용법

설치가 끝나면 Rails 서버를 시작하고 다음 경로로 이동하세요:

/rails/erd

모델을 수정할 때마다 다이어그램이 자동으로 업데이트되는 것을 확인할 수 있습니다.

동기

컨설팅 작업, 교육 세션, 그리고 Rails 개발을 하면서 저는 애플리케이션 도메인을 동적으로 살펴볼 수 있는 방법이 부족하다는 느낌을 자주 받았습니다. 다음과 같은 내장 도구와 비슷한 것이 있었으면 좋겠다고 생각했죠:

• /rails/mailers
• /sidekiq
• 내부 대시보드
• 통합 개발 도구

즉, URL 하나만 열면 바로 탐색을 시작할 수 있는 기능이 필요했습니다. 이러한 필요가 Rails Realtime ERD 탄생의 계기가 되었습니다.

기여

이 gem은 오픈 소스로 GitHub에서 제공됩니다:

https://github.com/jacksonpires/rails-realtime-erd

기여, 피드백, 이슈 및 제안 모두 환영합니다. Rails를 사용하면서 생산성과 아키텍처 이해를 높여주는 도구에 관심이 있다면 한 번 사용해 보세요.