fineman999 / nanum-fe

💛 SHARE HOUSE PLAYFORM PJT BY NANUM

---

**NANUM - 쉐어 하우스 프로젝트 **

한 줄 소개

• 외로움 없이 1인 가구로 살아나가고 싶은 사람들을 위한 쉐어하우스 서비스 플랫폼

---

기획 배경

• 1인가구의 연령대별 비율이 20대와 30대가 많고 이에 대안책으로 쉐어하우스가 많은 주목
• 구체적으로 집값은 계속해서 나날이 증가하고 1인 가구의 증가에 따라 고독사와 같은 사회문제와도 맞물리게 되는데 정작 쉐어하우스에 대한 정보를 교환할 공간도 부족

---

목표

• 팀 프로젝트를 수행하며, SW 개발 뿐만 아니라 팀원들과 함께 문제를 해결하기 위한 협업 역량을 배양

---

서비스 특징

• 투어와 입주 - 호스트가 등록한 하우스를 입주자가 투어 및 입주를 할 수 있다.
• 호스트 및 입주자와의 채팅 - 호스트 및 입주자들과의 소통을 위한 채팅 기능을 구현하여 하우스에 대해 궁금한 점을 즉각적으로 물어볼 수 있도록 하고, 입주자들 간 소통의 장을 마련한다.
• 사용자 간의 쪽지 - 관심 있는 항스에 거주 중인 사용자에게 쪽지를 보낼 수 있는 기능을 구현하여 생생한 정보를 얻을 수 있도록 한다.
• 정보 공유가 가능한 커뮤니티 - 사용자끼리 정보 공유가 가능한 커뮤니티를 마련하여 하우스 정보, 팁, 메이트 구하기 등 활발한 소통이 가능하도록 한다.

---

프로젝트

• 2022.09.15 ~ 2022.11.11 (45일/360시간)

• Github - FrontEnd

• Github - BackEnd

• Notion

  
  
  

📌 차례

---

1. 팀원소개
2. 주요 기술 스택
3. 아키텍쳐
4. ER Diagram
5. 서비스 소개
6. Git Branch
7. Commit 규칙
8. 시작하기

🔥 1. NANUM 팀원

---

• 박찬흠 - frontend/backend - fineman999
  • [email protected]
• 안대현 - backend - ads0070
  • [email protected]
• 강민수 - backend - Mins00oo
  • [email protected]
• 곽찬영 - frontend - chyg-ai
  • [email protected]
• 전호정 - frontend - hoho
  • [email protected]

⚙ 2. 주요 기술 스택

---

• Collaboration Tools

• FrontEnd

• BackEnd

• Devtools

---

🔨 3. 아키텍쳐

---

🔗 4. ER Diagram

🎞 3. 서비스 소개

1. 주요 버전

FrontEnd 주요 버전

프론트엔드 주요 버전
1. react : 18.2.0
2. next : 12.3.1
3. axios: 0.27.2
4. recoil : 0.7.5
5. mui : 5.10.8
6. Visual Studio : 1.71.0

BackEnd 주요 버전

1. JVM : 1.8.0_192
2. WAS : Tomcat 9.0.65
3. IntelliJ : IntelliJ IDEA 2021.3.2 (community)
4. springBootVer : '2.7.4'
5. Docker : 20.10.17
6. AWS RDS: 8.0.28
7. ubuntu: 20.04 LTS
8. JAVA: 11
9. 기타 상세 버전 정보
    - SpringBoot : build 도구 gradle 7.5

---

2. 서비스 소개 영상

3. 서비스 시연 영상

🌿 Git Branch

---

✨ (main) → (develop/ frontend) → (feature/<BE / FE>/)

• main : release branch

• develop : backend branch

• frontend : frontend branch

• feature/<BE/FE>/<feature> : 개별 개발 branch

✔ Commit 규칙

---

✨ 형태 : git commit -m '#[깃이슈번호] [git 컨벤션]: [작업내용]'

예시 ) git commit -m '#[깃이슈번호] feat 페이지네이션 기능 추가'

• git commit -m '#[깃이슈번호] style: 버튼 스타일링'

• git commit -m '#[깃이슈번호] fix: 팝업 버그 수정'

• git commit -m '#[깃이슈번호] docs: 리드미 수정'

✔ Git 컨벤션

---

• feat : 새로운 기능
• fix : 버그 수정
• docs : 문서 (문서 추가, 수정, 삭제)
• style : 포맷팅, 세미콜론 추가, etc) 코드 변화 없을 때
• refactor : 코드 리팩토링
• test : 테스트 추가, 테스트 리팩토링
• chore: 빌드 업무 수정, 패키지 매니지 수정

✔ 네이밍 규칙

---

• 변수 함수: camelCalse
• 클래스/컴포넌트/인터페이스: PascalCase
• 메소드 적용 예시 - C : createXXX ex) creatOrders - R : retrieveXXX ex) retrieveOrders - U : updateXXX ex) updateOrder - D : deleteXXX ex) deleteOrder

✔ 시작하기

---

# /backend/
$ gradlew clean build
$ build/libs/[서비스명].jar -jar app.jar

# /frontend/
$ npm install
$ npm start