Skip to content

Commit

Permalink
docs: readMe 문서 업데이트
Browse files Browse the repository at this point in the history
* docs: readMe 작성

* docs: 트러블 슈팅 문서 업데이트
  • Loading branch information
YongsHub authored Nov 10, 2023
1 parent ddb4903 commit f9d4ec3
Show file tree
Hide file tree
Showing 3 changed files with 81 additions and 3 deletions.
84 changes: 81 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,83 @@
# 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)

<br>
<br>
<br>

## 🏷️ 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

[김한성 Fork Repository](https://github.com/khs960616/ssaf-sound-be)

[신현철 Fork Repository](https://github.com/moonn6pence/ssaf-sound-be)

[이용준 Fork Repository](https://github.com/jjuny0310/ssaf-sound-be)

[김태용 Fork Repository](https://github.com/YongsHub/ssaf-sound-be)
<br><br>
</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 f9d4ec3

Please sign in to comment.