README.md

Devillage

• 프로젝트 기간 : 2022.09.16 ~ 2022.10.
• 배포 URL (서버 상태 : ON)
• Front Github

Preview

Project Goal ⛳

• 기본적인 CRUD 및 좋아요, 댓글, 대댓글, 북마크, 이미지 업로드 등 커뮤니티형 웹 어플리케이션에서 지원하는 기본적인 기능 구현
• Spring Security를 기반으로 Jwt(AccessToken, RefreshToken)와 OAuth2 인증 구현
• WebSocket을 활용한 채팅 기능 구현
• In-Memory DB (Redis)를 활용한 인증처리 구현
• Two-Factor 인증 구현
• AWS를 이용한 Https 통신 서버 운영
• CI/CD를 활용한 자동 배포 파이프라인 구축
• SpringRestDocs를 활용한 API 문서화
• Restful한 API 설계

Members 👪

양은찬(FE/BE)	김경근(BE)	조규원(BE)	강지원(BE)
@yangddoddi	@kkg5	@Qone2	@gangdodan

Stacks 🔧

#Back-end 언어 및 프레임워크

#Dependency

#Front-end 언어 및 프레임워크

#라이브러리

React.js, ReduxToolkit, Toast-Editor, antd, axios, jwt-decode
Redux-persist, SASS, react-cookie

#AWS

Architecture 📐

Documents 📁

기획 문서

• 요건 정의
• 정책서
• Flow chart
• 시나리오 정의서

개발 문서

• API
• ERD
• Sequence Diagram
• 클라이언트 통신

Ground Rule 💡

1. 커밋 시 클래스, 메서드 경계를 넘지 않게 최소 단위로 수정한다. 아무리 사소한 것이더라도 해당 메서드나 클래스 경계에 수정할 것이 그 부분 밖에 없다면 그것만 커밋할 것.
   (단, 특정 메서드에 밀접한 관계가 있는 DTO작성 시 같이 커밋할 수 있습니다.)
2. 1개 로직 완성 시마다 PullReqeust
3. 테스트는 반드시 단위테스트로 다른 레이어에 영향을 받지 않아야하며, 한 개 메서드당 실패 테스트도 최소 한 개 이상 포함한다.
4. 컨트롤러 테스트 시 RestDocs도 생성할 것 (HTML 제외)

Commit Strategy ✨

이름	내용
Feat	새로운 기능 추가
Fix	버그 수정
Docs	문서 수정
Style	코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
Refactor	코드 리펙토링
Test	테스트 코드, 리펙토링 테스트 코드 추가
Chore	빌드 업무 수정, 패키지 매니저 수정