Skip to content

Commit

Permalink
docs: readMe 작성
Browse files Browse the repository at this point in the history
  • Loading branch information
YongsHub committed Oct 31, 2023
1 parent 12ee9da commit 20f0b3b
Show file tree
Hide file tree
Showing 3 changed files with 142 additions and 3 deletions.
145 changes: 142 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,144 @@
# ssaf-sound-be
![로고](./picture/logo.png)

## API 명세서
<div style="text-align:center;">

[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 명세서 바로 가기](https://ssaf-sound.github.io/ssaf-sound-be/src/main/resources/static/docs/index.html)

<br>
<br>
<br>

## 🙌🏻 Member


| Backend | Backend | Backend | Backend | |
| :--------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------: | :-: |
| <img src="https://avatars.githubusercontent.com/u/65756225?v=4" width=400px alt="현철"/> | <img src="https://avatars.githubusercontent.com/u/55014803?v=4" width=400px alt="한성"/> | <img src="https://avatars.githubusercontent.com/u/59381113?v=4" width=400px alt="용준"/> | <img src="https://avatars.githubusercontent.com/u/86272688?v=4" width=400px alt="태용"> |
| [신현철](https://github.com/moonn6pence) | [김한성](https://github.com/khs960616) | [이용준](https://github.com/jjuny0310) | [김태용](https://github.com/YongsHub) |

<br><br>



## 🏷️ PROJECT GOAL

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

<br><br>



## 🏷️ PROJECT SKILL STACK

<img src="https://img.shields.io/badge/Spring-6DB33F?style=flat&logo=Spring&logoColor=white"/> <img src="https://img.shields.io/badge/Spring Boot-6DB33F?style=flat&logo=SpringBoot&logoColor=white"/> <img src="https://img.shields.io/badge/MySQL-4479A1?style=flat&logo=MySQL&logoColor=white"/> <img src="https://img.shields.io/badge/gradle-02303A?style=flat&logo=gradle&logoColor=white"/> <img src="https://img.shields.io/badge/redis-DC382D?style=flat&logo=redis&logoColor=white"/> <img src="https://img.shields.io/badge/docker-2496ED?style=flat&logo=docker&logoColor=white"/> <img src="https://img.shields.io/badge/amazonec2-FF9900?style=flat&logo=amazonec2&logoColor=white"/> <img src="https://img.shields.io/badge/amazonrds-527FFF?style=flat&logo=amazonRDS&logoColor=white"/> <img src="https://img.shields.io/badge/amazons3-569A31?style=flat&logo=amazons3&logoColor=white"/>

**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

<br>
</br>
<br>
</br>


## 🏷️ SSAF.SOUND Server Architecture

![서버 구조도](./picture/ssafsound%20architecture.jpg)

<br>
</br>
<br>
</br>


## 🏷️ 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과 모듈화를 통한 테스트 코드 개선](#5-custom-snippet과-모듈화를-통한-테스트-코드-개선)


<br><br>



# 1. MultipleBagFetchException 원인과 해결방법
<details>
<summary>Contents 확인</summary>
<div markdown="1">

</div>
</details>

<br>
<br>
<br>

# 2. Cookie 발급 시, 브라우저 정책과 RFC 6265 Cookie Processor 정책 이해하기
<details>
<summary>Contents 확인</summary>
<div markdown="2">

</div>
</details>

<br>
<br>
<br>

# 3. HandlerMethodArgumentResolver를 활용한 커스텀 애노테이션과 고민들
<details>
<summary>Contents 확인</summary>
<div markdown="3">

</div>
</details>

<br>
<br>
<br>

# 4. RestAssuredMockMvc 를 활용한 Controller Test 속도 개선
<details>
<summary>Contents 확인</summary>
<div markdown="4">

</div>
</details>

<br>
<br>
<br>

# 5. Custom Snippet과 모듈화를 통한 테스트 코드 개선
<details>
<summary>Contents 확인</summary>
<div markdown="5">

</div>
</details>

</div>
Binary file added picture/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added picture/ssafsound architecture.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 20f0b3b

Please sign in to comment.