🔗 GitHub에 내 프로젝트 공유하는 법 (처음부터 배포까지 정리)

✅ 1. GitHub 프로젝트 공개 전 체크리스트

• 민감한 정보 (application.properties, .env)는 .gitignore로 제외했는가?

• README.md가 작성되어 있는가?

• 불필요한 파일 (로그, 빌드 결과물 등)이 제거되었는가?

• 프로젝트가 실행 가능한 상태인가?

# 예시: Git에 올리기 전 .gitignore 설정
echo "/target" >> .gitignore
echo "*.log" >> .gitignore
echo ".env" >> .gitignore

---

🛠 2. GitHub에 프로젝트 올리는 전체 과정

# 1. 로컬 Git 초기화
git init

# 2. 원격 저장소 연결
git remote add origin https://github.com/your-id/your-repo.git

# 3. 파일 추가 및 커밋
git add .
git commit -m "Initial commit"

# 4. GitHub로 푸시
git push -u origin main

 

❗ GitHub 저장소 생성 시 README, .gitignore를 자동 생성하지 않는 것이 깔끔함 (로컬과 충돌 위험)

---

🔐 2-1. GitHub 토큰(PAT)으로 푸시할 때 인증하는 법

2021년부터 GitHub는 비밀번호 인증을 완전히 폐지, 토큰(Personal Access Token, PAT) 인증만 지원

 

➕ 토큰 생성 방법

1. GitHub 접속 → 우측 상단 프로필 → Settings

2. 왼쪽에서 Developer Settings → Personal Access Tokens → Tokens (classic) 클릭

3. [Generate new token] 클릭

• 권한은 최소 repo 체크

• Expiration은 90일, no expiration 중 선택

4. 생성된 토큰 문자열은 한 번만 표시되므로 반드시 복사해서 보관

 

➕ 푸시 시 인증 입력

git push -u origin main

 

• Username: GitHub ID 그대로 입력

• Password: GitHub 비밀번호 ❌ → 생성한 토큰 문자열 붙여넣기

---

🔄 기존 인증 정보 초기화 (원하는 경우)

• macOS: Keychain Access에서 github.com 검색 후 삭제

• Windows: 자격 증명 관리자에서 git:https://github.com 항목 삭제

🔑 한 번 로그인하면 Git이 캐시에 토큰 저장, 재사용 가능

---

📝 3. README.md 작성 팁

# 🍯 HoneyComboFactory

GS25, CU 편의점 상품을 조합하여 최고의 조합을 찾는 웹 애플리케이션

## 📦 기능
- 조합상품 추천
- 게시판 (작성, 수정, 삭제)
- 로그인/회원가입
- 리뷰 기능

## ⚙ 기술 스택
- Java 11 / Spring MVC / Oracle
- JSTL / JSP / JDBC Template
- MyBatis (진행 중)

## 🚀 실행 방법
1. Oracle DB 생성 및 테이블 스크립트 실행
2. `src/main/resources` 내 DB 설정 추가
3. Eclipse 또는 IntelliJ에서 실행

 

📌 GitHub에 올리는 목적 = 프로젝트를 모르는 사람이 이해하고 실행 가능해야 함

---

🌍 4. 프로젝트 공개 후 배포 및 알리는 방법

• GitHub Repository에 Topics 추가 (spring, oracle, personal-project)

• velog, Notion, LinkedIn, 블로그에 소개 포스팅 작성

• 프로젝트 요약 영상(GIF나 Loom 등)도 효과적

 

⚠️ 5. 자주 하는 실수와 실전 팁

실수	해결 방법
.gitignore 설정 안 해서 target/, .class 다 올라감	꼭 커밋 전에 확인
DB 계정 정보 깃헙에 업로드	.gitignore + config 파일 분리 필수
README 없는 채로 공개	최소한의 설명은 필수
깃헙에만 올리고 아무 데도 공유 안 함	커뮤니티 활용해야 피드백 받음

 

✍️ 마무리

GitHub는 단순 백업용이 아니라, 나의 기술 포트폴리오
깔끔하게 정리해서 올려두면 나중에 내 실력 증명자료로도 충분히 활용 가능