diff --git a/README.md b/README.md index ab74a4b0..5bca2587 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,160 @@ -# ssaf-sound-be +![로고](./picture/logo.png) -## API 명세서 +
-[Spring Rest Docs API 명세서](https://ssaf-sound.github.io/ssaf-sound-be/src/main/resources/static/docs/index.html) +### [SSAF.SOUND 바로가기](https://ssafsound.com) + +
+ +

+ +
+ +## 🏷️ SSAF.SOUND Rest Docs + +
+ +
+ +### [Rest Docs API 명세서 바로 가기]() + +
+ + + +
+ +

+ +## 🙌🏻 Member + +
+ +| Backend | Backend | Backend | Backend | | +| :--------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------: | :-: | +| 현철 | 한성 | 용준 | 태용 | +| [신현철](https://github.com/moonn6pence) | [김한성](https://github.com/khs960616) | [이용준](https://github.com/jjuny0310) | [김태용](https://github.com/YongsHub) | + +

+ +
+ +## 🏷️ PROJECT GOAL + +
+ +SSAFY를 희망하는 예비 싸피생부터 이수한 싸피생들과 현재 교육을 받고 있는 싸피생들까지 ❗️ +[에브리타임](https://everytime.kr) 을 모티브로 삼아 SSAFY 생활 정보를 간접적으로 경험하고 공유할 수 있으며 '익명' 을 통해 적극적인 커뮤니케이션의 장이 될 수 있도록 기획했습니다. + +

+ +
+ +## 🏷️ PROJECT SKILL STACK + + + +**Language |** Java 11 + +**Framework |** Spring Boot 2.7 + +**Data(RDBMS) |** Spring-Data-JPA 2.7.14, QuertDSL 5.0.0, MySQL 8.0 + +**Cache |** Redis 2.7.14 + +**Build Tool |** Gradle + +**Test |** Junit 5.8.2, Mockito 4.5.1, JaCoCo 0.8.8 + +
+ +
+
+ +
+ +## 🏷️ SSAF.SOUND Server Architecture + +
+ +![서버 구조도](./picture/ssafsound%20architecture.jpg) + +
+
+ +
+ +## 🏷️ SSAF.SOUND TROUBLE SHOOTING + +[MultipleBagFetchException 발생시 해결 방법](#1-multiplebagfetchexception-원인과-해결방법) + +[Cookie 발급 시, 브라우저 정책과 RFC 6265 Cookie Processor 정책 이해하기](#2-cookie-발급-시-브라우저-정책과-rfc-6265-cookie-processor-정책-이해하기) + +[HandlerMethodArgumentResolver를 활용한 커스텀 애노테이션과 고민들](#3-handlermethodargumentresolver를-활용한-커스텀-애노테이션과-고민들) + +[RestAssuredMockMvc 를 활용한 Controller Test 속도 개선](#4-restassuredmockmvc-를-활용한-controller-test-속도-개선) + +[Custom Snippet과 모듈화를 통한 테스트 코드 개선]() + +
+ + +

+ + + +# 1. MultipleBagFetchException 원인과 해결방법 +
+Contents 확인 +
+ +
+
+ +
+
+
+ +# 2. Cookie 발급 시, 브라우저 정책과 RFC 6265 Cookie Processor 정책 이해하기 +
+Contents 확인 +
+ +
+
+ +
+
+
+ +# 3. HandlerMethodArgumentResolver를 활용한 커스텀 애노테이션과 고민들 +
+Contents 확인 +
+ +
+
+ +
+
+
+ +# 4. RestAssuredMockMvc 를 활용한 Controller Test 속도 개선 +
+Contents 확인 +
+ +
+
+ +
+
+
+ +# 5. Custom Snippet과 모듈화를 통한 테스트 코드 개선 +
+Contents 확인 +
+ +
+
\ No newline at end of file diff --git a/picture/logo.png b/picture/logo.png new file mode 100644 index 00000000..52d203c7 Binary files /dev/null and b/picture/logo.png differ diff --git a/picture/ssafsound architecture.jpg b/picture/ssafsound architecture.jpg new file mode 100644 index 00000000..b88dad20 Binary files /dev/null and b/picture/ssafsound architecture.jpg differ