코드를 읽지 않고 10k+ 라인 Github Repos를 이해하십시오.

저자의 이미지 | 캔버
큰 코드베이스를 탐색하고 이해하는 것은 특히 프로젝트에 가입하거나 구형 저장소를 다시 방문 할 때 특히 큰 코드베이스를 탐색하고 이해하는 것은 어려울 수 있습니다. 코드 구조를 이해하는 전통적인 방법에는 시간이 많이 걸리고 오류가 발생하기 쉬운 수많은 파일 및 문서를 읽는 것이 포함됩니다. Gitdiagram은 Github 리포지토리를 대화식 다이어그램으로 변환하여 Codebase 아키텍처를 시각적으로 표현하여 솔루션을 제공합니다. 이 도구는 복잡한 시스템을 이해하고 개발 팀 간의 협업을 향상시키는 데 도움이됩니다. 이 기사에서는 Gitdiagram을 로컬로 사용하는 단계별 프로세스를 안내해 드리겠습니다. 따라서 더 이상 기다리지 않고 시작합시다.
Gitdiagram을 로컬로 사용하기위한 단계별 안내서
1 단계 : Gitdiagram 저장소를 복제하십시오
git clone
cd gitdiagram
2 단계 : 종속성을 설치합니다
이것은 종속성을 node_modules로 가져오고 설치합니다.
PNPM 설치를 실행하기 전에 Node.js 및 PNPM이 전 세계적으로 설치되어 있는지 확인하십시오.
- node.js를 설치하려면 nodejs.org에서 다운로드하십시오
- PNPM을 설치하려면 다음 명령을 실행하십시오.
3 단계 : 환경 변수 설정
편집 .env 파일 OpenAi / Anthropic / OpenRouter API 키 및 선택적으로 GitHub Personal Access Token을 포함합니다.
4 단계 : 백엔드 서비스를 시작합니다
docker-compose up --build -d
Fastapi 서버는 사용할 수 있습니다 로컬 호스트 : 8000. 서버쪽에 다음 메시지가 표시됩니다.
{"message":"Hello from GitDiagram API!"}
5 단계 : 데이터베이스 초기화
데이터베이스를 설정하려면 다음 명령을 실행하십시오.
chmod +x start-database.sh
./start-database.sh
pnpm db:push
임의의 암호를 생성하라는 메시지가 표시되면 입력 예. Postgres 데이터베이스는 컨테이너에서 시작됩니다 로컬 호스트 : 5432.
메모: 이 명령을 실행하려고하면이 오류가 발생했습니다.
sh: drizzle-kit: command not found
ELIFECYCLE Command failed.
WARN Local package.json exists, but node_modules missing, did you mean to install?
이슬비 키트를 설치하지 않은 것으로 나타났습니다. 따라서 이것을 보면 그냥 실행하십시오.
그 후, pnpm db : 푸시가 잘 작동 하고이 출력을 주었다.
No config path provided, using default 'drizzle.config.ts'
Reading config file '/Users/kanwal/Desktop/gitdiagram/drizzle.config.ts'
Using 'postgres' driver for database querying
[✓] Pulling schema from database...
[✓] Changes applied
6 단계 : 프론트 엔드를 실행하십시오
이제 웹 사이트에 액세스 할 수 있습니다 로컬 호스트 : 3000 및 Backend/App/Routers/Generate.py에 정의 된 속도 제한을 Generate Decorator에서 편집합니다. Fastapi 라이브러리의 Github Repo를 시각화 해 보겠습니다.
프론트 엔드 인터페이스 :
산출:
결론 생각
이것은 훌륭한 아이디어이며 정말 유용한 저장소입니다. 나는 개인적으로 내 프로젝트에서 이와 같은 것이 필요하다고 느꼈으므로 그 뒤에있는 노력과 비전에 감사드립니다.
즉, 편견없는 의견을 제시하는 것은 분명히 개선의 여지가 있습니다.
내가 실행 한 반복 문제 중 하나는 다음과 같습니다.
Syntax error in text mermaid version 11.4.
프로젝트 소유자 인 Ahmedkhaleel2004에 따르면,이 오류는 일반적으로 LLM 생성 된 Mermaid.js 구문을 의미합니다.
나는이 문제를 여러 가지 방법으로 해결하려고 시도했지만 궁극적으로 신뢰할 수있는 수정이 없다는 것을 알았습니다. 대부분 LLM의 한계입니다. Mermaid.js 코드를 검증 할 수있는 방법이 있다면 도움이 될 것입니다. 그러나 현재로서는 어떻게 확실하지 않습니다.
또한 현재 프롬프트 (`rompts.py`
✅ 온라인에서 찾은 솔루션
GitHub 문제를 파헤 치는 동안 실제로 저를 위해 일한 다른 사용자가 공유 한 해결 방법을 발견했습니다.
이것을 사용자 정의 다이어그램 프롬프트에 추가하십시오 : Mermaid 버전 11.4.1의 구문 문제를 무시하고 나머지 다이어그램을 재생하십시오.
이 라인을 사용하면 오류를 우회하는 데 도움이되었습니다. 일부 구성 요소는 여전히 누락 될 수 있지만 적어도 부분 다이어그램을 생성했습니다. 코드베이스에 대한 높은 수준의 이해를 제공합니다.
Kanwal Mehreen Kanwal은 머신 러닝 엔지니어이자 데이터 과학에 대한 열정과 AI의 의학 교차점을 가진 기술 작가입니다. 그녀는 eBook “Chatgpt의 생산성을 극대화하는 것”을 공동 저술했습니다. APAC의 Google Generation Scholar 2022로서 그녀는 다양성과 학업 우수성을 챔피언시킵니다. 그녀는 또한 Tech Scholar, Mitacs Globalink Research Scholar 및 Harvard Wecode Scholar의 Teradata 다양성으로 인정 받고 있습니다. Kanwal은 STEM 분야의 여성에게 힘을 실어주기 위해 펨코드를 설립 한 변화에 대한 열렬한 옹호자입니다.
Post Comment