📝 Docs: README 파일 작성 진행 중

[Bersk3r]

✅ 작업 사항

README 파일 제작 진행 중

• 대략적인 틀 작성

👩‍💻 공유 포인트 및 논의 사항

팀 미팅 내에서 의논하여 내용을 정리하여 작성할 예정

[github-actions]

🎉 구현한 기능 Preview: https://we-kit-bucket-or5vgon1z-bersk3rs-projects.vercel.app

[Bersk3r]

• 5517d68

📙📄 WekitBucket 👨‍💻😎

코드잇 스프린트 6기 Part 3 과정에서 8팀이 진행한 중급 프로젝트 WekitBucket 레포지토리

🔗 배포 주소

https://wekit-bucket.vercel.app

🔗 발표 자료

https://www.canva.com/design/DAGKHfn-U0Y/HhE-GjRBlfJns68CXuD5Xg/edit

🏃프로젝트 소개

친구들의 정보를 저장하고 만드는 공간 WekitBucket

• 친구들이 보는 나는 어떨까라는 주제로 함께 만들어가는 나의 위키 페이지
• 자유게시판을 활용하여 친구를 찾고 소통할 수 있는 페이지

📌 주요 기능

• 헤더

  • 로고 클릭 시, 마이페이지로 이동
  • 위키 목록 클릭 시, 위키 목록 페이지로 이동
  • 자유게시판 클릭 시, 자유게시판 페이지로 이동
  • 로그인이 되지 않는 경우, 로그인 표시
  • 로그인이 되어 있는 경우, 알람 및 사용자 프로필 정보 표시

  

  
  

• 랜딩 페이지

  • 초기 시작 페이지

  

  
  

• 위키 목록 페이지

  • 내용

  • 토스트 창

    • 내용

  • 내 위키 페이지

    • 내용

    

    
    

  • 질문 등록 페이지

    • 내용

    

    
    

  • 수정 페이지

    • 내용

    

    
    

• 자유게시판 페이지

  • 내용

  

  
  

⚒️ 개발 일정

⌛2024.06.21 (금) ~ 2024.07.19 (화)

📝 프로젝트 기간 중 수행 내용

1. 사용 기술 스택 선정 및 개발 일정 논의
2. 프로젝트 관련 개발 환경 셋업
3. 역할 분담
4. 프로젝트 구현
  - 공통 사용 컴포넌트 역할 분배
  - 페이지 단위 역할 분배
  - 기능 구현 및 API 연동
5. 발표 및 자료 준비
6. 리팩토링 및 문서화

👩🏻‍💻 팀원 소개

김민재	김영운	이종욱	이은빈	유예하
@PixeIDark	@YoungUnKim	@bersk3r	@eunbinnie	@YehaYoo

🤝 역할 분담

김민재

• 프로젝트 초기 세팅 담당
• API 및 유틸 담당
• 위키 목록 페이지 담당
• 프로젝트 발표 담당

김영운

• 회원가입 페이지 담당
• 비밀번호 변경 페이지 담당
• 위키 만들기 페이지 담당
• 내 위키 페이지 담당

이종욱

• 헤더, 토스트, 알람 컴포넌트 제작
• 사용자, 알람, 토스트 전역 컨텍스트 담당
• 배포 및 자동화 작업 담당
• README 파일 담당

이은빈

• 로그인 페이지 담당
• 자유게시판 페이지 및 404 페이지 담당
• 게시글 상세 페이지 담당
• 애니메이션 효과 적용 담당

유예하

• 랜딩 페이지 담당
• 게시글 등록 페이지 담당
• 게시글 수정 페이지 담당
• 프로젝트 발표 자료 준비 및 시연 영상 제작 담당

💻 기술 스택

• Environment

• Config

• Development

• Deploy

• CI / CD

• Collaboration Tools

🗂️ 폴더 구조

^WekitBucket

📦src
 ┣ 📂apis
 ┃ ┣ 📂article
 ┃ ┣ 📂auth
 ┃ ┣ 📂comment
 ┃ ┣ 📂image
 ┃ ┣ 📂notification
 ┃ ┣ 📂profile
 ┃ ┗ 📂user
 ┣ 📂app
 ┃ ┣ 📂(auth)
 ┃ ┃ ┣ 📂login
 ┃ ┃ ┃ ┣ 📂_components
 ┃ ┃ ┃ ┗ 📜page.tsx
 ┃ ┃ ┗ 📂signup
 ┃ ┃ ┃ ┣ 📂_components
 ┃ ┃ ┃ ┗ 📜page.tsx
 ┃ ┣ 📂(boards)
 ┃ ┃ ┣ 📂addboard
 ┃ ┃ ┃ ┣ 📂[id]
 ┃ ┃ ┃ ┃ ┗ 📜page.tsx
 ┃ ┃ ┗ 📂boards
 ┃ ┃ ┃ ┣ 📂components
 ┃ ┃ ┃ ┃ ┣ 📂allArticles
 ┃ ┃ ┃ ┃ ┣ 📂bestArticles
 ┃ ┃ ┃ ┃ ┗ 📂search
 ┃ ┃ ┃ ┣ 📂[id]
 ┃ ┃ ┃ ┃ ┣ 📂components
 ┃ ┃ ┃ ┃ ┗ 📜page.tsx
 ┃ ┃ ┃ ┗ 📜page.tsx
 ┃ ┣ 📂(mypage)
 ┃ ┃ ┣ 📂changepassword
 ┃ ┃ ┃ ┣ 📂_components
 ┃ ┃ ┃ ┗ 📜page.tsx
 ┃ ┃ ┣ 📂makewiki
 ┃ ┃ ┃ ┣ 📂_components
 ┃ ┃ ┃ ┗ 📜page.tsx
 ┃ ┣ 📂(wiki)
 ┃ ┃ ┣ 📂wiki
 ┃ ┃ ┃ ┣ 📂[code]
 ┃ ┃ ┃ ┃ ┣ 📂components
 ┃ ┃ ┃ ┃ ┃ ┣ 📂Common
 ┃ ┃ ┃ ┃ ┃ ┃ ┗ 📂lottie
 ┃ ┃ ┃ ┃ ┃ ┗ 📂Profile
 ┃ ┃ ┃ ┃ ┣ 📂_constants
 ┃ ┃ ┃ ┃ ┣ 📂_hook
 ┃ ┃ ┃ ┃ ┣ 📂_style
 ┃ ┃ ┃ ┃ ┗ 📜page.tsx
 ┃ ┃ ┣ 📂wikilist
 ┃ ┃ ┃ ┣ 📂_components
 ┃ ┃ ┃ ┗ 📜page.tsx
 ┃ ┣ 📂test
 ┃ ┃ ┣ 📂_components
 ┃ ┃ ┗ 📜page.tsx
 ┃ ┣ 📂_components
 ┃ ┃ ┣ 📂Landing
 ┃ ┃ ┗ 📂_Header
 ┃ ┣ 📜layout.tsx
 ┃ ┣ 📜page.tsx
 ┃ ┗ 📜template.tsx
 ┣ 📂assets
 ┃ ┣ 📂fonts
 ┃ ┃ ┗ 📂pretendard
 ┃ ┣ 📂icons
 ┃ ┣ 📂images
 ┃ ┗ 📜index.ts
 ┣ 📂components
 ┣ 📂context
 ┣ 📂hooks
 ┣ 📂styles
 ┣ 📂types
 ┗ 📂utils

🌲 깃 브랜치 전략 (Trunk-Based 전략)

1. main 브랜치에서 기반으로 로컬에서 브랜치 생성
2. 로컬에서 작업이 완료 후, pull Request 작성
   • main 브랜치에 변동 사항이 있으면 작업하고 있는 코드에 반영 후 push 진행
   • Conflict가 발생하면, 충돌이 발생된 부분을 Resolve 한 후에 merge 진행
3. Pull Request에 대한 merge를 진행하는 경우, 리뷰어로 설정된 팀원 중
   
   2명 이상의 승인이 완료되면 작성자가 직접 merge를 눌러 main 브랜치로 병합.
   • merge 기능을 사용하여, 여러 개의 커밋을 하나의 커밋으로 통합
   • discord Webhooks을 통해 PR이 생성될 때 알림 오도록 설정

🚨 프로젝트 내 발생한 문제점 / 해결방안

문제점

• Github Orginazation에 대한 배포 시 유료 기능 지원 문제

해결 방안

• Git Action을 활용하여 자동 배포 및 PR 프리뷰 생성 ([Feat/addboard 페이지 #32](github link))

📗 프로젝트 내 잘한 점 / 아쉬운 점

😊 잘한 점

R&R을 통해 업무 분담을 한 후, 매일마다 보고하는 형식으로 진행

• 각자의 맡은 역할이 완료되면 보고 후, 현재 남은 작업을 수행

😮‍💨 아쉬운 점

건강 관리를 제대로 하지 못함

• 다들 열심히 참여하느라, 수면 시간이 불규칙한 문제가 존재함

[github-actions]

🎉 구현한 기능 Preview: https://we-kit-bucket-4rr8g1hmi-bersk3rs-projects.vercel.app

[github-actions]

🎉 구현한 기능 Preview: https://we-kit-bucket-w1qtth2ik-bersk3rs-projects.vercel.app