haydenschmitty/floorplan

해결하는 문제

Floorplan은 특히 코드베이스가 커졌거나 AI의 도움을 받아 구축된 경우, 코드 구조를 파악하기 어렵다는 문제를 해결합니다. 코드의 기능을 쉬운 언어로 설명하는 시각적 지도를 제공하여, 애플리케이션의 각 부분이 어떻게 연결되어 있는지, 특정 사용자 작업 중에 어떤 일이 발생하는지, 보안 취약점이나 사용되지 않는 파일과 같은 잠재적 문제가 어디에 있는지 이해하도록 돕습니다.

작동 방식

Floorplan은 Claude Code 또는 Codex를 사용하여 파일, 임포트, 웹 요청을 포함한 코드베이스를 스캔합니다. 각 구성 요소의 목적을 식별하고 대화형 로컬 전용 지도를 생성합니다. "주문이 들어오면 어떤 일이 발생하나요?" 또는 "Stripe와는 어디서 통신하나요?"와 같이 자연어로 질문하여 이 지도와 상호 작용할 수 있습니다. 코드를 변경하면 도구가 점진적으로 업데이트되므로 수동 유지 관리 없이도 지도를 최신 상태로 유지할 수 있습니다.

대상 사용자

복잡한 코드베이스를 빠르게 이해해야 하는 개인 개발자 및 팀, 새로운 팀원 온보딩, AI 기반 변경 사항이 애플리케이션 아키텍처에 미치는 영향을 추적하려는 분들을 위해 설계되었습니다. 또한 제품 요구 사항에서 청사진을 생성하여 새 프로젝트를 계획하는 데에도 유용합니다.

주요 기능

• 파일 및 리포지토리 간의 연결을 보여주는 확대/축소 가능한 대화형 지도.
• 코드 구성 요소 및 기술 엔드포인트에 대한 쉬운 언어 설명.
• 데이터 흐름 추적 및 아키텍처 질문에 답변하는 "Ask the map" 기능.
• 보안 위험, 사용되지 않는 파일, 과도하게 큰 구성 요소를 식별하는 자동 상태 점검.
• AI 어시스턴트가 수행한 변경 사항을 강조하는 "Recent work" 보기.
• 코드를 작성하기 전에 애플리케이션을 시각화하고 계획하기 위한 청사진 모드.
• 외부 종속성 없이 로컬 머신에서 실행되며 git에 코드를 커밋할 필요가 없습니다.