개발_초기_설정 - 100-hours-a-week/12-marong-Wiki GitHub Wiki

프로젝트 개발 환경 세팅 가이드

1. VSCode 설치

VSCode 다운로드

Visual Studio Code를 설치합니다.

2. 가상환경(Venv) 설정 및 실행

python -m venv marong

# 가상환경 활성화 (Mac/Linux)
source marong/bin/activate

# 가상환경 비활성화
deactivate

아래처럼 (marong) 표시가 뜨면 정상 활성화!

가상환경 활성화

3. .gitignore 설정

최상위 프로젝트 폴더에 .gitignore 파일을 만들고 아래 내용을 추가합니다.

# Python
venv/
__pycache__/
*.pyc

# 환경변수/보안
.env

# 기타 불필요한 파일
.DS_Store
*.log

4. GitHub 원격 저장소 Clone

git clone https://github.com/100-hours-a-week/12-marong-AI-place.git
cd 12-marong-AI-place
# 브랜치 확인
git branch

5. 필수 패키지 설치

pip install -r requirements.txt

6. Python 버전 확인

python --version

7. 개발 및 GitHub 커밋/푸시 프로세스

① Staging (git add)

git add <파일명>  # 파일별로 추가
git add .         # 전체 파일 추가 (단, .gitignore에 등록된 파일은 제외!)
staging

② Commit (git commit)

git commit -m "커밋 메시지"
commit 
# 커밋 취소
git reset --soft HEAD~1

③ Push (git push)

git push origin <브랜치이름>
push

8. 대용량 파일 업로드 (GitHub LFS)

GitHub는 기본적으로 50MB 이상의 파일 업로드를 제한하므로,
대용량 파일은 가능하면 업로드를 피해야 합니다.

그러나 업로드가 불가피한 경우(Vector DB, Fine-tuned Model 등), 아래 절차에 따라 Git LFS(Large File Storage)를 사용합니다.

GitHub LFS 설치

먼저 해당 디렉토리가 Git 레포지토리로 초기화되어 있어야 합니다.

git lfs install

업로드할 대용량 파일 트래킹 설정

업로드 대상 폴더 또는 파일명을 지정합니다.
예: chroma_db 디렉토리를 트래킹할 경우

git lfs track "chroma_db"

위 명령어를 실행하면 .gitattributes 파일에 자동으로 규칙이 추가됩니다.

평소처럼 add → commit → push 진행

git add .
git commit -m "feat: Chroma DB 파일 추가"
git push origin main  # 또는 원하는 브랜치

주의사항

  • GitHub LFS는 무료 요금제 기준 저장 용량이 2GB 제한으로 이 이상의 파일을 업로드하는 경우 사용 요금제를 업그레이드해야 합니다.
  • 해당 사항이 발생하는 경우 팀 내에서 충분히 상의 후 진행하시기 바랍니다.
⚠️ **GitHub.com Fallback** ⚠️