Skip to content

README.md

Latest commit

 

History

History
183 lines (134 loc) · 5.11 KB

README.md

File metadata and controls

183 lines (134 loc) · 5.11 KB

RootIn

TIL 작성 페이지

📌 프로젝트 개요

<본문 내용 작성하기>

📌 프로젝트 기획서

🛠 기술 스택

구분 기술
Frontend
UI / UX
Backend
Auth
AI
Database
Storage
Infra / SDK
Build Tool
Test
Collaboration

♣️ Backend

♠️ DataBase

✨ 주요 기능 (Key Features)

1. 동기부여를 위한 식물 키우기 기능

2. AI를 통한 TIL 초안 작성 및 면접 예상 질문 기능

3. 간편한 블로그 방식

👥 팀원 소개

이름 역할 담당 기능
신문규 팀장
이소연 팀원
정재운 팀원
최윤석 팀원
고완석 팀원

📂 디렉토리 구조 (Directory Structure)

RootIn/
├── frontend/ # Vite + React 기반 프론트엔드
│ ├── src/
│ │ ├── app/
│ │ │ ├── api/ # Axios 기반 API 통신 모듈
│ │ │ ├── components/ # 공통 컴포넌트 및 Shadcn UI
│ │ │ ├── hooks/ # 비즈니스 로직 분리 (Custom Hooks)
│ │ │ ├── pages/ # 서비스 주요 화면
│ │ │ └── types/ # TypeScript 타입 정의
├── src/main/ # Spring Boot 기반 백엔드
│ ├── java/com/example/ # Java 소스 코드
│ └── resources/
│ ├── db/ # Oracle DB 스키마 및 초기화 SQL
│ └── application.yml # 서버 설정 파일
└── README.md

🤝 팀 규칙 및 협업 방식

🧩 Git & 코드 협업 컨벤션

1. 회의 및 커뮤니케이션

  • 데일리 스크럼: 오전 9시 수업 시작 전, 각자 전날 작업 리뷰 및 컨디션/이슈 공유
  • 주간 회의: 매주 목요일 수업 시간 또는 멘토링 전 진척도 점검 및 공통 할 일 정리
  • 멘토링: 목 또는 금요일 저녁, 가능하면 전원 참석

2. 협업 문화

  • 1시간 고민한 문제는 팀에 바로 공유
  • 요청이 있을 때 적극적으로 돕는 분위기 조성
  • 다양한 의견이 자유롭게 오갈 수 있도록 상호 존중
  • 정기 일정(회의/멘토링 등) 불참 시 사전 공유 필수
  • 슬랙 커뮤니케이션 규칙:
    • 공지 확인 시 ✅ 이모지
    • 이슈/작업 관련 내용은 슬랙에 기록
      • 논의 필요시 [이슈 제목] 채팅으로 시작, 관련 논의는 스레드로 이어가기

📌 커밋 컨벤션 (prefix)

1. 태그목록

태그 설명
feat 새로운 기능 추가
fix 버그 수정
style 코드 스타일 변경
refactor 리팩토링
design CSS 등 디자인 수정
comment 주석 추가/수정
docs 문서 수정
test 테스트 추가/수정
chore 설정/빌드 등 기타 변경
rename 파일명/폴더명 변경
remove 파일 삭제

2. Commit 내용

[기능분류]: [작성내용] - [날짜]
  • 기능분류: 작업의 성격
  • 수정/작성내용: 추가·수정한 작업 내용을 간단히 요약
  • 수정/작성일: 작업을 완료한 날짜 (YYYY-MM-DD)

Commit 규칙 상세

[기능분류]: [파일명] - [작업내용] - [날짜]
  • 작성내용 앞에 작업한 파일명 명시
  • 작업내용을 중심으로 간단히 작성
# 예시
git commit -m "feat: Login/index.js - 로그인 추가 - 26.01.22"
git commit -m "feat: components/Header.js - 헤더구현 - 26.01.22"
git commit -m "feat: component/Header.js, Home/index.js - 헤더로 메인화면 돌아가는 기능 구현 - 26.01.22"

바람직한 PR 주기

  • PR 생성 타이밍: 기능 단위 완료 시, 하루 작업 마무리 시, 리뷰가 필요할 때
  • PR 규모 예시:
    • 파일 수 5~10개 이하
    • 코드 200~500줄 이하
    • 리뷰 시간 30분 이내

Merge 규칙

  • 코드 리뷰 후 30분~1시간 내 머지 권장
  • 리뷰 없을 시, 작성자가 직접 머지 가능

🔹 트러블 슈팅 & 해결 방식

  • 예시
1. WebSocket 연결 안정성 확보

- [문제]
  - 페이지 이동 시 소켓 연결이 빈번하게 끊기는 현상.
- [해결]
  - WebSocket 연결을 전역 Context로 관리하고, 자동 재연결 로직을 적용하여 안정성을 개선했습니다.

2. 소셜 로그인 유저 데이터 통합

- [문제]
  - 로그인 제공자별 식별 체계 차이로 인한 DB 저장 충돌.
- [해결]
  - 유저 테이블에 제공자 정보를 추가하여 식별자 구조를 유연하게 설계하고 데이터를 통합했습니다.