diff --git a/README.md b/README.md index 3cf212b..4b47c69 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,180 @@ -## 광운대학교 무인양품 백엔드 +
+ + KW Muji + +

"학생 중심의 학업 및 협업 효율화 플랫폼"

+ [광운 대학 생활 도우미] +
+ +
+ +## 💡 프로젝트 개요 + +대학 생활을 하게 되면 많은 팀 프로젝트와 설문 조사를 진행하게 됩니다. + +팀원을 모집 및 설문 조사를 하기 위해, 대학교 유명 커뮤니티 에브리타임에 글을 올리거나 카카오톡 등 SNS를 통해 개인적인 연락을 하고 있습니다. + +하지만, 이 플랫폼들은 팀원 모집과 설문 조사와는 맞지 않는 플랫폼으로 많은 사람들에게 관심을 끌기 어려우며, 이는 학업에 악영향을 끼치게 됩니다. + +그래서 광운대학교 학생들의 **팀 프로젝트 효율성을 향상**시키고 **학생들의 학업과 대외활동을 체계적으로 관리**하도록 돕고자, **대학 생활을 통합적으로 관리할 수 있는 플랫폼,** <광운 대학 생활 도우미>를 만들게 되었습니다. + +
+ +## ⭐ 서비스 기능 + +### [회원가입 및 로그인] + + - 회원가입 정보를 작성합니다. + - 광운대학교 이메일로 인증번호 요청을 합니다. + - 광운 대학 생활 도우미로부터 받은 인증 번호로 인증 후, 회원가입을 진행합니다. + +회원가입 및 로그인 + +
+ +### [팀 프로젝트 팀원 모집 글 작성] + + - 메인 페이지에서 팀플 모집을 눌러 팀플 게시글 페이지로 이동합니다. + - 글쓰기를 버튼을 눌러 팀원 모집 글을 작성합니다. + - 필요 시 사진 업로드를 할 수 있습니다. + - 마감일을 설정한 뒤 글을 발행합니다. + - 본인의 모집 글을 확인하면 지원자 보기 기능을 통해 지원자를 확인할 수 있습니다. + +팀 프로젝트 팀원 모집 글 작성 + +
+ +### [팀 프로젝트 팀원 신청] + + - 팀플 게시글에서 원하는 글을 들어갑니다. 이때, 글을 검색할 수 있습니다. + - 팀플 신청 버튼을 누르고 이전에 올린 포트폴리오중 제출할 포트폴리오를 선택해 지원합니다. + - 마이페이지에서 지원한 팀플을 확인할 수 있습니다. + +팀 프로젝트 팀원 신청 + +
+ +### [내가 모집 중인 팀 프로젝트 관리] + + - 마이페이지에서 My 모집 팀플 페이지로 이동합니다. + - 모집 중인 팀플에서 지원자의 포트폴리오를 확인 후, 마음에 드는 팀원을 선택하고 팀플을 시작합니다. + - 선발된 팀원들에게 선정 알림 메일이 자동으로 전송됩니다. + - 이후, My 팀플 페이지에서 진행중인 팀플로 확인이 가능합니다. + +내가 모집 중인 팀 프로젝트 관리 + +
+ +### [설문 조사 요청 글 작성] + + - 메인페이지에서 설문 조사 페이지로 이동합니다. + - 글쓰기 버튼을 눌러 설문 조사할 내용을 작성합니다. + - 질문 추가 및 삭제가 가능하며, 질문 유형은 단답식 및 객관식으로 설정할 수 있습니다. + - 마감일을 설정한 뒤, 발행 버튼을 누르면 글이 정상적으로 게시됩니다. + +설문 조사 요청 글 작성 + +
+ +### [설문 조사 참여] + + - 설문 조사 게시글에서 원하는 글을 들어갑니다. 이때, 글을 검색할 수 있습니다. + - 설문 조사에 대한 답변을 작성하고 제출을 누르면 정상적으로 설문조사가 제출됩니다. + - 이때, 설문 조사는 한 번만 참여 가능합니다. (중복 참여 불가) + +설문 조사 참여 + +
+ +### [설문 조사 결과 답변 확인] + + - 마이페이지에서 My 설문 페이지로 이동합니다. + - 결과 보기 버튼을 눌러 본인이 게시했던 설문조사의 결과를 확인합니다. + - 각 응답자 별로 응답 내용을 확인할 수 있습니다. + - 설문 조사 종료 버튼을 누르면 설문조사가 종료되어 더이상 참여할 수 없습니다. + +설문 조사 결과 답변 확인 + +
+ +### [팀플 일정, 개인 일정 관리] + + - 메인페이지에서 캘린더 페이지로 이동합니다. + - 일정은 개인 일정, 팀플 일정 두 가지 유형으로 추가할 수 있습니다. + - 팀플 일정 유형 선택 후, 참여 중인 팀플을 선택해 내용 및 시간을 기입하여 추가합니다. + - 이때, 팀플 일정은 모든 팀원들의 캘린더에 공유됩니다. + - 개인 일정도 내용 및 시간을 기입하여 추가할 수 있습니다. + - 캘린더에서 x 버튼을 누르면 일정이 삭제됩니다. + +팀 일정, 개인 일정 관리 + +
+ +### [학교 홈페이지 공지사항 확인] + + - 메인페이지에서 주요 4가지 카테고리 별 공지사항을 미리볼 수 있습니다. + - 공지사항 페이지로 이동하여, 12가지의 카테고리 별 공지사항을 확인할 수 있습니다. + - 검색을 통해 원하는 내용의 공지사항을 찾을 수 있습니다. + - 제목을 클릭하게 되면, 학교 홈페이지에서 해당 공지사항의 세부 내용 페이지로 이동하게 됩니다. + +학교 홈페이지 공지사항 확인 + +
+ +### [마이페이지 내 정보 관리] + + - 팀플 지원 시 필요한 포트폴리오를 추가 및 삭제로 관리할 수 있습니다. (최대 3개) + - 프로필 관리 페이지로 이동하여, 프로필 사진 변경 및 사용자 정보를 변경할 수 있습니다. + +마이페이지 내 정보 관리 + +
+ +## ⚒️ 시스템 아키텍처 + +시스템 아키텍처 + +
+ +## 📜 ERD + +ERD + +
## 💻 Convention ### Git Flow 전략 -*추후 작성* +**브랜치 흐름** + + (개발 과정 - develop 브랜치 및 하위 브랜치) + 1. Upstream Repository에서 Issue를 생성합니다. + 1-1. Commit Convention에 해당하는 이름(대문자)과 기능 목표를 제목으로 생성합니다. + 1-2. 예시: [FEAT] 로그인 기능 구현 + 2. develop 브랜치에서 Issue에 맞는 브랜치를 생성합니다. + 2-1. feature(기능 개발), fix(오류 등 수정), refactor(리팩토링) 브랜치로 생성합니다. + 2-2. 예시: feature/#{이슈 번호}_{브랜치 개발 목표} -> feature/#12_login + 3. Local에서 생성한 브랜치로 checkout하여 개발을 진행합니다. + 4. Local에서 기능 개발이 완료되면 작업 브랜치로 push합니다. + 4-1. 커밋 컨벤션은 아래의 컨벤션을 따릅니다. + 4-2. 예시: {Commit Type}: {커밋 메시지}({이슈 번호}) + 5. 작업 브랜치의 내용을 develop 브랜치로 PR을 보냅니다. + + (배포 과정 - main 브랜치) + 6. Upstream Repository에서 develop 브랜치에서 최종 release될 브랜치인 main에 PR을 보냅니다. + 7. Deployments와 gitHub Actions의 설정에 따라 모두 정상 통과되면 정상 배포가 완료됩니다. + +
### Commit Convention + {Commit Type}: {커밋 메시지}({이슈 번호}) + {description} + + 예시: feat: 로그인 기능 구현 + - spring security 설정 + | Commit Type | Description | |-------------|----------------------| @@ -17,4 +184,53 @@ | refactor | 코드 리팩토링 | | test | 테스트 관련 코드 | | chore | 빌드 업무 수정, 패키지 매니저 수정 | -| cicd | 배포 관련 작업 | \ No newline at end of file +| cicd | 배포 관련 작업 | + +
+ +## 👨‍👩‍👧‍👦 팀원 소개 + + + + + + + + + + + + + + + + + + + + +
+ 최지훈 + + 김정윤 + + 조은향 + + 김민곤 +
+ + + + + + + +
+ 팀장, BE, DB, Infra(CI/CD) + + BE, DB + + FE + + FE +
\ No newline at end of file