Skip to content

Commit

Permalink
Merge pull request #219 from Team-TenTen/docs/readme
Browse files Browse the repository at this point in the history
[Docs]: ๋ฆฌ๋“œ๋ฏธ ์—…๋ฐ์ดํŠธ
  • Loading branch information
young970 authored Feb 2, 2024
2 parents d72bdb5 + 40e4a7c commit af4899a
Showing 1 changed file with 72 additions and 30 deletions.
102 changes: 72 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,68 @@
- ์Šฌ๋ž™ ํ˜น์€ ๋‹จํ†ก๋ฐฉ์—์„œ ํŒ€์›๋“ค์ด ํ•ด๋‹น ๋งํฌ๋ฅผ ๋ดค๋Š”์ง€ ํ™•์ธํ•˜๊ณ  ์‹ถ๋‹ค.
- ์Šฌ๋ž™ ํ˜น์€ ์นด์นด์˜ค ๋‹จํ†ก๋ฐฉ์— ๋งํฌ๋ฅผ ๊ณต์œ ํ•˜๋ฉด ํ•ด๋‹น ๋งํฌ๋ฅผ ๋ณธ ์ธ์›๋“ค์„ ํŒŒ์•…ํ•˜๊ณ  ์‹ถ๋‹ค.
- ์ง€์—ญ ๋ง›์ง‘ ํ˜น์€ ์‡ผํ•‘๋ชฐ ๋“ฑ์„ ๊ฒ€์ƒ‰ํ•˜๋ฉด ์–‘์งˆ์˜ ์ •๋ณด๊ฐ€ ์•„๋‹Œ ๋งŽ์€ ๊ด‘๊ณ ๋“ค๋กœ ์ธํ•ด ์ •๋ณด๋ฅผ ํ•„ํ„ฐ๋งํ•˜๋Š” ์ถ”๊ฐ€์ ์ธ ๋น„์šฉ์ด ์†Œ๋ชจ๋œ๋‹ค.
## ๐Ÿ”— ํ•ต์‹ฌ ๊ธฐ๋Šฅ ๐Ÿ”—
- **๋งํฌ ์•„์นด์ด๋น™**:
<br>๋งํฌ์˜ ๋ฉ”ํƒ€ํƒœ๊ทธ๋ฅผ ํ†ตํ•ด ์ž๋™์œผ๋กœ ์ œ๋ชฉ์„ ์ถ”์ฒœํ•ด์ฃผ๋ฉฐ ํƒœ๊ทธ๋ฅผ ํ†ตํ•ด ์ถ”ํ›„ ํ•„ํ„ฐ๋ง์˜ ์šฉ์ด์„ฑ์„ ์˜ฌ๋ฆผ
<img width="948" alt="แ„‰แ…ณแ„แ…ณแ„…แ…ตแ†ซแ„‰แ…ฃแ†บ 2024-01-23 แ„‹แ…ฉแ„Œแ…ฅแ†ซ 1 38 16" src="https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/370b6e66-141d-415c-b685-5da911142f87">


- **๊ณต์œ  ์•„์นด์ด๋น™ ๊ณต๊ฐ„**:
<br>์ŠคํŽ˜์ด์Šค ์ดˆ๋Œ€ ๊ธฐ๋Šฅ์„ ํ†ตํ•ด ์–ธ์ œ๋“ ์ง€ ํŒ€์›๋“ค์„ ์ดˆ๋Œ€ํ•  ์ˆ˜ ์žˆ์œผ๋ฉฐ viewer ๋ฐ editor ๋“ฑ์˜ ์„ธ๋ถ€ ๊ถŒํ•œ ์ง€์ •์ด ๊ฐ€๋Šฅํ•˜๋‹ค. ๋˜ํ•œ ์„ค์ • ์‹œ ํŒ€์›๋“ค์˜ ๋งํฌ ์กฐํšŒ ์ด๋ ฅ์„ ํ‘œ์‹œํ•  ์ˆ˜ ์žˆ๋‹ค.
<img width="957" alt="แ„‰แ…ณแ„แ…ณแ„…แ…ตแ†ซแ„‰แ…ฃแ†บ 2024-01-23 แ„‹แ…ฉแ„Œแ…ฅแ†ซ 1 38 33" src="https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/53bf0690-1e53-4e83-8db2-e140971eb1fd">


- **์ฆ๊ฒจ์ฐพ๊ธฐ**:
<br>๊ณต๊ฐœ๋œ ์ŠคํŽ˜์ด์Šค(๋งํฌ ์ €์žฅ์†Œ)๋Š” ์ฆ๊ฒจ์ฐพ๊ธฐ ๊ธฐ๋Šฅ์„ ํ†ตํ•ด ๊ตฌ๋…์„ ํ•  ์ˆ˜ ์žˆ๋‹ค. ๋˜ํ•œ ๋งŽ์€ ์œ ์ €๋“ค์—๊ฒŒ ์ฆ๊ฒจ์ฐพ๊ธฐ๋œ ์ŠคํŽ˜์ด์Šค๋Š” ๋ฉ”์ธํ™”๋ฉด ์ฆ๊ฒจ์ฐพ๊ธฐ ์ˆœ ์˜ต์…˜์—์„œ ์ƒ์œ„์— ๋…ธ์ถœ๋˜๊ฒŒ ๋œ๋‹ค.
<img width="948" alt="แ„‰แ…ณแ„แ…ณแ„…แ…ตแ†ซแ„‰แ…ฃแ†บ 2024-01-23 แ„‹แ…ฉแ„Œแ…ฅแ†ซ 1 38 47" src="https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/5a6d8d7a-6dfe-4433-9b0f-878b2ef89741">


- **๊ฐ€์ ธ์˜ค๊ธฐ**:
<br>๊ณต๊ฐœ๋œ ์ŠคํŽ˜์ด์Šค๋ฅผ(๋งํฌ ์ €์žฅ์†Œ) ๋ณต์‚ฌํ•˜์—ฌ ํŽธ์ง‘ ๊ฐ€๋Šฅํ•œ ๋‚˜์˜ ์ŠคํŽ˜์ด์Šค๋กœ ๋งŒ๋“ค ์ˆ˜ ์žˆ๋‹ค. ์ฆ๊ฒจ์ฐพ๊ธฐ์™€ ๋‹ค๋ฅด๊ฒŒ ์›๋ณธ์˜ ์ดํ›„ ๋ณ€๊ฒฝ์‚ฌํ•ญ์€ ๋ฐ˜์˜๋˜์ง€ ์•Š๋Š”๋‹ค.
<img width="955" alt="แ„‰แ…ณแ„แ…ณแ„…แ…ตแ†ซแ„‰แ…ฃแ†บ 2024-01-23 แ„‹แ…ฉแ„Œแ…ฅแ†ซ 1 39 06" src="https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/b4539f72-a9ff-4120-ad98-c431a2e26f9d">

## ๐Ÿ”— ๊ธฐ๋Šฅ ์‹œ์—ฐ ๐Ÿ”—
### ๋ฉ”์ธ ํ™”๋ฉด ๋ฐ ๊ฒ€์ƒ‰
์ข‹์•„์š”๋ฅผ ๋งŽ์ด ๋ฐ›์€ ์ƒ์œ„ ๋งํฌ๋“ค๊ณผ ์ตœ์‹ ์ˆœ ํ˜น์€ ์ฆ๊ฒจ์ฐพ๊ธฐ ์ˆœ์˜ ์ŠคํŽ˜์ด์Šค(๋งํฌ ์ €์žฅ์†Œ)๋ฅผ ํ•„ํ„ฐ๋งํ•˜์—ฌ ๋ณด์—ฌ์ค€๋‹ค. ๋˜ํ•œ ๊ฒ€์ƒ‰ ๊ธฐ๋Šฅ์„ ์ œ๊ณตํ•˜์—ฌ ํŽธ์˜์„ฑ ํ™•๋ณด
<div style="text-align:center; margin-top:5px;">
<div style="display:inline-block; margin-right:10px;">
<img height="300" src="https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/14368d47-d597-4bac-a375-4886b10f3eb4">
<p style="margin-top:1px;">๋ฉ”์ธ ํŽ˜์ด์ง€</p>
</div>
<div style="display:inline-block; margin-right:10px;">
<img height="300" src="https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/4ace19c3-0419-4955-a4de-1b2e355046de">
<p style="margin-top:1px;">์ŠคํŽ˜์ด์Šค(๋งํฌ ์ €์žฅ์†Œ) ๊ฒ€์ƒ‰</p>
</div>
<div style="display:inline-block;">
<img height="300" src="https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/de209ba9-8871-4953-b86e-18360a794269">
<p style="margin-top:1px;">์œ ์ € ๊ฒ€์ƒ‰</p>
</div>
</div>

### ๋งํฌ ์•„์นด์ด๋น™
๋งํฌ์˜ ๋ฉ”ํƒ€ํƒœ๊ทธ๋ฅผ ํ†ตํ•ด ์ž๋™์œผ๋กœ ์ œ๋ชฉ์„ ์ถ”์ฒœํ•ด์ฃผ๋ฉฐ ํƒœ๊ทธ๋ฅผ ํ†ตํ•ด ์ถ”ํ›„ ํ•„ํ„ฐ๋ง์˜ ์šฉ์ด์„ฑ์„ ์˜ฌ๋ฆผ
<div style="text-align:center; margin-top:5px;">
<div style="display:inline-block; margin-right:10px;">
<img height="300" src="https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/73319202-e0eb-437d-8521-9907fc4bf856">
<p style="margin-top:1px;">๋งํฌ ์ƒ์„ฑ</p>
</div>
<div style="display:inline-block;">
<img height="300" src="https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/18b07c5f-e369-4772-88c3-81e28a29c0ef">
<p style="margin-top:1px;">๋งํฌ ํ•„ํ„ฐ๋ง</p>
</div>
</div>

### ๊ณต์œ  ์•„์นด์ด๋น™ ๊ณต๊ฐ„
์ŠคํŽ˜์ด์Šค ์ดˆ๋Œ€ ๊ธฐ๋Šฅ์„ ํ†ตํ•ด ์–ธ์ œ๋“ ์ง€ ํŒ€์›๋“ค์„ ์ดˆ๋Œ€ํ•  ์ˆ˜ ์žˆ์œผ๋ฉฐ viewer ๋ฐ editor ๋“ฑ์˜ ์„ธ๋ถ€ ๊ถŒํ•œ ์ง€์ •์ด ๊ฐ€๋Šฅํ•˜๋‹ค. ๋˜ํ•œ ์„ค์ • ์‹œ ํŒ€์›๋“ค์˜ ๋งํฌ ์กฐํšŒ ์ด๋ ฅ์„ ํ‘œ์‹œํ•  ์ˆ˜ ์žˆ๋‹ค.
<div style="text-align:center; margin-top:5px;">
<div style="display:inline-block; margin-right:10px;">
<img height="300" src="https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/cae806df-b646-491d-97ba-611179d92cc7">
<p style="margin-top:1px;">์ดˆ๋Œ€ ํ•˜๊ธฐ</p>
</div>
<div style="display:inline-block; margin-right:10px;">
<img height="300" src="https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/9ed2649d-49ce-4209-9136-84b29e2a938e">
<p style="margin-top:1px;">์ดˆ๋Œ€ ๋ฐ›๊ธฐ</p>
</div>
<div style="display:inline-block;">
<img height="300" src="https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/e4748848-8b7e-41af-9a40-cb0de6524f28">
<p style="margin-top:1px;">๋งํฌ ์กฐํšŒ ์ด๋ ฅ ํ‘œ์‹œ</p>
</div>
</div>

### ์ฆ๊ฒจ์ฐพ๊ธฐ
๊ณต๊ฐœ๋œ ์ŠคํŽ˜์ด์Šค(๋งํฌ ์ €์žฅ์†Œ)๋Š” ์ฆ๊ฒจ์ฐพ๊ธฐ ๊ธฐ๋Šฅ์„ ํ†ตํ•ด ๊ตฌ๋…์„ ํ•  ์ˆ˜ ์žˆ๋‹ค. ๋˜ํ•œ ๋งŽ์€ ์œ ์ €๋“ค์—๊ฒŒ ์ฆ๊ฒจ์ฐพ๊ธฐ๋œ ์ŠคํŽ˜์ด์Šค๋Š” ๋ฉ”์ธํ™”๋ฉด ์ฆ๊ฒจ์ฐพ๊ธฐ ์ˆœ ์˜ต์…˜์—์„œ ์ƒ์œ„์— ๋…ธ์ถœ๋˜๊ฒŒ ๋œ๋‹ค.
<div style="text-align:center; margin-top:5px;">
<img height="300" src="https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/e7d6fc60-fe21-499c-bb9e-7c6db1d5354a">
<p style="margin-top:1px;">์ฆ๊ฒจ์ฐพ๊ธฐ</p>
</div>

### ๊ฐ€์ ธ์˜ค๊ธฐ
๊ณต๊ฐœ๋œ ์ŠคํŽ˜์ด์Šค๋ฅผ(๋งํฌ ์ €์žฅ์†Œ) ๋ณต์‚ฌํ•˜์—ฌ ํŽธ์ง‘ ๊ฐ€๋Šฅํ•œ ๋‚˜์˜ ์ŠคํŽ˜์ด์Šค๋กœ ๋งŒ๋“ค ์ˆ˜ ์žˆ๋‹ค. ์ฆ๊ฒจ์ฐพ๊ธฐ์™€ ๋‹ค๋ฅด๊ฒŒ ์›๋ณธ์˜ ์ดํ›„ ๋ณ€๊ฒฝ์‚ฌํ•ญ์€ ๋ฐ˜์˜๋˜์ง€ ์•Š๋Š”๋‹ค.
<div style="text-align:center; margin-top:5px;">
<img height="300" src="https://github.com/Team-TenTen/LinkHub-BE/assets/108216455/e8757df5-c505-4473-a0d9-4412e8cf656e">
<p style="margin-top:1px;">๊ฐ€์ ธ์˜ค๊ธฐ</p>
</div>

## ๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘ฆ ์„œ๋ฒ„ ํŒ€์› ์†Œ๊ฐœ
| Team Leader |Developer | Developer |
Expand All @@ -44,17 +86,17 @@

## ๐Ÿ’ป ๊ธฐ์ˆ ์Šคํƒ
### ๊ฐœ๋ฐœ ํ™˜๊ฒฝ
<img src="https://img.shields.io/badge/java_17 -007396?style=for-the-badge&logo=java&logoColor=white"></a>
<img src="https://img.shields.io/badge/springboot 3.1.0-6DB33F?style=for-the-badge&logo=springboot&logoColor=white"></a>
<img src="https://img.shields.io/badge/-Spring Data JPA-gray?style=for-the-badge&logoColor=white"/></a>
<img src="https://img.shields.io/badge/Query DSL-0078D4?style=for-the-badge&logo=Spring Data JPA&logoColor=white"/></a>
<img src="https://img.shields.io/badge/mysql 8.0-4479A1?style=for-the-badge&logo=mysql&logoColor=white"> </a>
<img src="https://img.shields.io/badge/Redis-DC382D?style=for-the-badge&logo=redis&logoColor=white"/></a>
<img src="https://img.shields.io/badge/java_17 -007396?style=for-the-badge&logo=java&logoColor=white"></a>
<img src="https://img.shields.io/badge/springboot 3.1.0-6DB33F?style=for-the-badge&logo=springboot&logoColor=white"></a>
<img src="https://img.shields.io/badge/-Spring Data JPA-gray?style=for-the-badge&logoColor=white"/></a>
<img src="https://img.shields.io/badge/Query DSL-0078D4?style=for-the-badge&logo=Spring Data JPA&logoColor=white"/></a>
<img src="https://img.shields.io/badge/mysql 8.0-4479A1?style=for-the-badge&logo=mysql&logoColor=white"> </a>
<img src="https://img.shields.io/badge/Redis-DC382D?style=for-the-badge&logo=redis&logoColor=white"/></a>
<img src="https://img.shields.io/badge/gradle-02303A?style=for-the-badge&logo=gradle&logoColor=white"></a>
<img src="https://img.shields.io/badge/Junit-25A162?style=for-the-badge&logo=JUnit5&logoColor=white"/></a>
<img src="https://img.shields.io/badge/Spring Security-6DB33F?style=for-the-badge&logo=spring-security&logoColor=white"/></a>
<img src="https://img.shields.io/badge/Spring Oauth2-000000?style=for-the-badge&logo=oauth2&logoColor=white"></a>
<img src="https://img.shields.io/badge/mapstruct-6DB33F?style=for-the-badge&logo=mapstruct&logoColor=white"></a>
<img src="https://img.shields.io/badge/Junit-25A162?style=for-the-badge&logo=JUnit5&logoColor=white"/></a>
<img src="https://img.shields.io/badge/Spring Security-6DB33F?style=for-the-badge&logo=spring-security&logoColor=white"/></a>
<img src="https://img.shields.io/badge/Spring Oauth2-000000?style=for-the-badge&logo=oauth2&logoColor=white"></a>
<img src="https://img.shields.io/badge/mapstruct-6DB33F?style=for-the-badge&logo=mapstruct&logoColor=white"></a>

### ์ธํ”„๋ผ
<img src="https://img.shields.io/badge/amazon aws-232F3E?style=for-the-badge&logo=amazonaws&logoColor=white"></a>
Expand All @@ -80,7 +122,7 @@
![แ„‰แ…ณแ„แ…ณแ„…แ…ตแ†ซแ„‰แ…ฃแ†บ 2023-12-03 แ„‹แ…ฉแ„’แ…ฎ 4 44 07](https://github.com/Team-TenTen/LinkHub-BE/assets/90172648/15b82f59-5f85-4567-996d-66652ac44aa0)



## ๋ฌธ์„œ

[๐Ÿ“ LinkHub API ๋ช…์„ธ์„œ ](https://www.notion.so/prgrms/API-c9e7dd4d09b246999a0022273810e4f7?pvs=4) <br>
Expand Down

0 comments on commit af4899a

Please sign in to comment.