기여자 설정

요구 사항

• Git (필수)
• Node.js v24.16.0 (필수)
• npm v11.16.0 (필수)
• MongoDB (필수, 데이터베이스용)
• Git LFS (더 큰 파일에 유용함)
• GitHub Desktop (선택 사항)
• VSCode (권장 소스 코드 편집기)

권장되는 VSCode 확장 프로그램

VS Code에 다음 확장 프로그램을 설치하세요:

• Prettier
• ESLint
• GitLens

환경 준비

Node.js 및 npm

nvm을 사용하는 경우, LibreChat을 설치하기 전에 권장되는 Node.js 버전을 설치하고 선택하세요:

nvm install 24.16.0
nvm use 24.16.0
npm install -g [email protected]

셸이 예상되는 버전을 사용하고 있는지 확인하세요:

node -v
npm -v

v24.16.0
11.16.0

GitHub

• LibreChat 저장소를 포크하세요: https://github.com/danny-avila/LibreChat/fork

• 포크(fork)한 저장소에 브랜치를 생성하고, 적절한 이름을 지정한 뒤, 원본 저장소에 연결하세요.

• 새 브랜치를 로컬 PC로 다운로드하세요

git clone -b branch-name https://github.com/username/LibreChat.git

branch-name와 username을 본인의 세부 정보로 바꾸세요.

VS Code에서 열기

• 브랜치를 복제한 후:

  cd LibreChat

  code .

LibreChat 준비하기

• VS Code에서 ctrl+shift+`를 눌러 터미널을 엽니다.

  또는 ctrl+j를 사용하여 하단 창을 열고 터미널을 선택하세요.

• npm run smart-reinstall

  Node.js 또는 npm 버전을 방금 변경했다면, 깔끔한 설치를 위해 npm run reinstall을 한 번 실행하세요.

• npm run build

• .env 구성

  • .env 파일을 생성하세요. 파일이 없다면 .env.example을 복제하여 구성하세요.

개발 워크플로우

LibreChat에서 효율적으로 작업하려면 다음 명령어를 사용하세요:

• 백엔드 시작하기:

  • 일반적인 작동을 위해서는 npm run backend를 사용하세요.
  • 활발한 개발을 위해서는 npm run backend:dev를 사용하여 변경 사항을 모니터링하세요.
  • http://localhost:3080/에서 액세스하세요.

• 개발 모드에서 프론트엔드 실행하기:

  • 백엔드가 실행 중인지 확인하세요.
  • npm run frontend:dev를 사용하여 프론트엔드 변경 사항을 모니터링하세요.
  • http://localhost:3090/에서 확인하세요.

로컬 테스트

제출하기 전에 로컬에서 업데이트를 테스트하세요. 자세한 내용은 다음을 참조하세요: Perform Tests Locally

테스트를 실행하여 기여한 내용이 견고하며 통합할 준비가 되었는지 확인하세요.

커밋, 푸시, 풀 리퀘스트 (PR)

커밋하기

Commits는 개발 과정에서 논리적인 체크포인트를 표시합니다. 변경 사항을 설명하는 명확한 메시지를 포함하세요.

예시:

git add .
git commit -m "Add login functionality"

변경 사항 푸시

기능 구현이나 문제 해결을 완료한 후 변경 사항을 원격 저장소로 Push하세요.

예시:

git push origin feature-branch-name

Pull Request (PR) 생성하기

Pull Request는 기능 브랜치에서 메인 브랜치로 변경 사항을 병합합니다.

1. main 브랜치에서 최신 변경 사항을 가져와 충돌을 해결하세요.
2. 업데이트된 기능 브랜치를 푸시합니다.
3. 코드가 프로젝트 가이드라인을 따르는지 확인하세요.

예시:

git checkout main
git pull origin main
git checkout feature-branch-name
git rebase main
# Resolve conflicts if any
git push origin feature-branch-name
# Open PR on GitHub

브라우저에서 저장소에 접속한 후 "Contribute"를 클릭하세요.

커밋 안전하게 되돌리기 (Revert)

기능 브랜치에서 변경 사항을 되돌리려면 다음 단계를 주의 깊게 따르십시오:

• git pull origin feature-branch-name

• git log

• git rebase -i HEAD~N

  제거할 커밋의 pick을 drop으로 변경하세요. 편집기를 저장하고 종료하세요.

• git push --force-with-lease origin feature-branch-name