Skip to content

Commit ed84b77

Browse files
Jummi10cse0518
authored andcommitted
Update README.md
1 parent f23a39a commit ed84b77

File tree

1 file changed

+69
-32
lines changed

1 file changed

+69
-32
lines changed

โ€ŽREADME.mdโ€Ž

Lines changed: 69 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
## **๋‚ด ์ธ์ƒ ์„ฑ์žฅ๊ณก์„  ์‚ฌ์ดํŠธ - Surf ๐Ÿ„๐Ÿปโ€โ™‚๏ธ**
1+
<img src="https://capsule-render.vercel.app/api?type=waving&color=0:5b8dd2,50:81b4ef,100:81b4cf&height=300&section=header&text=Surf.&fontColor=fff&fontSize=70&fontAlignY=40&desc=my%20own%20growth%20curve%20service&descAlignY=60" width="100%"/>
2+
3+
4+
5+
# **๋‚ด ์ธ์ƒ ์„ฑ์žฅ๊ณก์„  ์‚ฌ์ดํŠธ - _**Surf.**_ ๐Ÿ„๐Ÿปโ€โ™‚๏ธ**
26

37
์ธ์ƒ์€ surfing ์„ ํƒ€๋Š” ๊ฒƒ์ฒ˜๋Ÿผ ์ฆ๊ฒ์ง€๋งŒ, suffering ๋˜ํ•œ ํ”ผํ•  ์ˆ˜ ์—†๋‹ค.
48

@@ -8,71 +12,104 @@
812

913
---
1014

11-
## ๐Ÿง‘๐Ÿฝโ€๐Ÿคโ€๐Ÿง‘๐ŸปํŒ€์› ์†Œ๊ฐœ
15+
## ๐Ÿ‘จโ€๐Ÿ’ปํŒ€์› ์†Œ๊ฐœ
1216

1317
| [์ตœ์Šน์€](https://github.com/cse0518) | [๋ฐ•์ˆ˜๋นˆ](https://github.com/suebeen) | [๋ฐ•์ •๋ฏธ](https://github.com/Jummi10) | [์ „ํšจํฌ](https://github.com/kwhyo) |
1418
| :---: | :---: | :---: | :---: |
1519
| <img src="https://avatars.githubusercontent.com/u/60170616?v=4" width="150" height="150"> | <img src="https://user-images.githubusercontent.com/56287836/146503568-f24e194a-ff54-4340-89d5-66a042cd5d02.png" width="150" height="150"> | <img src="https://user-images.githubusercontent.com/56287836/146504190-28688cf8-0435-421f-808a-ff97f12c25a8.png" width="150" height="150"> | <img src="https://user-images.githubusercontent.com/60170616/146600241-4f634fce-7845-4a54-bd2f-7f6410fecffa.png" width="150" height="150"> |
16-
| ํŒ€์žฅ, ๊ฐœ๋ฐœ์ž | ๊ฐœ๋ฐœ์ž | ๊ฐœ๋ฐœ์ž | ๊ฐœ๋ฐœ์ž |
20+
| ํŒ€์žฅ, ๊ฐœ๋ฐœ์ž | ์Šคํฌ๋Ÿผ ๋งˆ์Šคํ„ฐ, ๊ฐœ๋ฐœ์ž | ๊ฐœ๋ฐœ์ž | ๊ฐœ๋ฐœ์ž |
21+
22+
<br>
1723

1824
## ๐Ÿ“ํ”„๋กœ์ ํŠธ ๋ชฉํ‘œ ๋ฐ ์ƒ์„ธ ์„ค๋ช…
1925

20-
์—ด์‹ฌํžˆ ๋‹ฌ๋ ค์˜จ ๋‚˜ ์ž์‹ ! ์—ด์‹ฌํžˆ๋Š” ํ•˜๊ณ  ์žˆ๋Š”๋ฐ ๋‚ด๊ฐ€ ์–ผ๋งˆ๋‚˜ ๋ฐœ์ „ํ–ˆ๋Š”์ง€ ๊ธฐ๋กํ•˜๋Š” ๊ณต๊ฐ„์€ ์—†์„๊นŒ? ๊ทธ๋ƒฅ ์ผ๊ธฐ๋Š” ๋ฉ”๋ชจ์žฅ์—๋ผ๋„ ์ ์„ ์ˆ˜ ์žˆ๊ณ , ๋ธ”๋กœ๊ทธ๋Š” ์ด๋ฏธ ๋ฌด์ˆ˜ํžˆ ์กด์žฌํ•˜๊ณ , ์ƒ‰๋‹ค๋ฅธ ๋ฐฉ๋ฒ•์œผ๋กœ ๋™๊ธฐ๋ถ€์—ฌ ๋ฐ›๊ณ  ๊ธฐ๋กํ•˜๊ณ  ๊ณต์œ ํ•˜๋Š”
26+
์—ด์‹ฌํžˆ ๋‹ฌ๋ ค์˜จ ๋‚˜ ์ž์‹ ! ์—ด์‹ฌํžˆ๋Š” ํ•˜๊ณ  ์žˆ๋Š”๋ฐ **๋‚ด๊ฐ€ ์–ผ๋งˆ๋‚˜ ๋ฐœ์ „ํ–ˆ๋Š”์ง€** ๊ธฐ๋กํ•˜๋Š” ๊ณต๊ฐ„์€ ์—†์„๊นŒ? ๊ทธ๋ƒฅ ์ผ๊ธฐ๋Š” ๋ฉ”๋ชจ์žฅ์—๋ผ๋„ ์ ์„ ์ˆ˜ ์žˆ๊ณ , ๋ธ”๋กœ๊ทธ๋Š” ์ด๋ฏธ ๋ฌด์ˆ˜ํžˆ ์กด์žฌํ•˜๊ณ , **์ƒ‰๋‹ค๋ฅธ ๋ฐฉ๋ฒ•**์œผ๋กœ ๋™๊ธฐ๋ถ€์—ฌ ๋ฐ›๊ณ  ๊ธฐ๋กํ•˜๊ณ  ๊ณต์œ ํ•˜๋Š”
2127
๊ทธ๋Ÿฐ ๊ณต๊ฐ„์ด ํ•„์š”ํ•ด! ๐Ÿ™†โ€โ™€๏ธ
2228

23-
- ์„ฑ์žฅ๊ณก์„ ์œผ๋กœ ํ•œ๋ˆˆ์— ๋‚ด ์ธ์ƒ์„ ๋Œ์•„๋ณด๊ธฐ
24-
- ๋‚จ๋“ค์˜ ์„ฑ์žฅ๊ณก์„ ์„ ๋ณด๋ฉฐ ๋™๊ธฐ๋ถ€์—ฌ๋„ ๋ฐ›๊ธฐ
29+
- **์„ฑ์žฅ๊ณก์„ **์œผ๋กœ ํ•œ๋ˆˆ์— ๋‚ด ์ธ์ƒ์„ ๋Œ์•„๋ณด๊ธฐ
30+
- ๋‚จ๋“ค์˜ ์„ฑ์žฅ๊ณก์„ ์„ ๋ณด๋ฉฐ **๋™๊ธฐ๋ถ€์—ฌ**๋„ ๋ฐ›๊ธฐ
2531
- ๊ณก์„ ์˜ ํŠน์ • ๊ตฌ๊ฐ„๋งˆ๋‹ค ๊ธฐ๋ก๋„ ๋‚จ๊ธฐ๊ธฐ
2632
- ๊ณก์„ ์ด ์•„๋‹Œ ๊ธฐ๋ก๋“ค๋งŒ ๋ชจ์•„์„œ ๋ณด๊ธฐ
27-
- ํ•„์š”ํ•˜๋‹ค๋ฉด ํฌํŠธํด๋ฆฌ์˜ค๋กœ๋„ ์‚ฌ์šฉ ๊ฐ€๋Šฅํ•˜๊ธฐ
33+
- ํ•„์š”ํ•˜๋‹ค๋ฉด **ํฌํŠธํด๋ฆฌ์˜ค**๋กœ๋„ ์‚ฌ์šฉ ๊ฐ€๋Šฅํ•˜๊ธฐ
34+
35+
<br>
2836

2937
## ๐Ÿ› ๏ธ๊ฐœ๋ฐœ ์–ธ์–ด ๋ฐ ํ™œ์šฉ ๊ธฐ์ˆ 
3038

3139
**๊ฐœ๋ฐœ ํ™˜๊ฒฝ**
3240

33-
- IDE : **IntelliJ**
34-
- ๊ฐœ๋ฐœ ์–ธ์–ด : **Java 17**
35-
- ํ”„๋ ˆ์ž„์›Œํฌ : **SpringBoot 2.6.1**
36-
- ์˜์†์„ฑ ํ”„๋ ˆ์ž„์›Œํฌ : **JPA**
37-
- ๋นŒ๋“œ๋„๊ตฌ : **Gradle**
38-
- ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค : **MySQL**
39-
- ์Šคํ† ๋ฆฌ์ง€ : **S3**
41+
- **Springboot** ๋กœ ์›น ์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜ ์„œ๋ฒ„๋ฅผ ๊ตฌ์ถ•ํ–ˆ์–ด์š”.
42+
- ๋นŒ๋“œ๋„๊ตฌ๋Š” **Gradle**์„ ์‚ฌ์šฉํ–ˆ์–ด์š”.
43+
- ๋‹ค์–‘ํ•œ ๊ธฐ๋Šฅ๊ณผ ์•ˆ์ •์„ฑ์„ ์œ„ํ•ด LTS ๋ฒ„์ „์ธ **Java 17** ๋ฒ„์ „์„ ์‚ฌ์šฉํ–ˆ์–ด์š”.
44+
- **Spring Data JPA(Hibernate)** ๋กœ ๊ฐ์ฒด ์ง€ํ–ฅ ๋ฐ์ดํ„ฐ ๋กœ์ง์„ ์ž‘์„ฑํ–ˆ์–ด์š”.
45+
- **QueryDSL** ๋กœ ์ปดํŒŒ์ผ ์‹œ์ ์— SQL ์˜ค๋ฅ˜๋ฅผ ๊ฐ์ง€ํ•ด์š”. JPA ์ธํ„ฐํŽ˜์ด์Šค๋กœ ํ•ด๊ฒฐํ•˜๊ธฐ ํž˜๋“  ๋™์ ์ด๊ณ  ๋ณต์žกํ•œ query๋ฅผ ๋ณด์™„ํ•˜๊ณ  ๋” ๊ฐ€๋…์„ฑ ๋†’์€ ์ฝ”๋“œ๋ฅผ ์ž‘์„ฑํ•  ์ˆ˜ ์žˆ์–ด์š”.
46+
- ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค๋Š” **MySQL**์„ ์‚ฌ์šฉํ–ˆ์–ด์š”.
47+
48+
**Infrastructure**
49+
50+
- **AWS EC2**๋ฅผ ์‚ฌ์šฉํ•ด ์„œ๋ฒ„๋ฅผ ๊ตฌ์ถ•ํ–ˆ์–ด์š”.
51+
- **S3** ๋กœ ํŒŒ์ผ์„ ์—…๋กœ๋“œํ•˜๊ณ  ๋ณด๊ด€ํ•ด์š”.
4052

4153
**ํ˜‘์—… ๊ด€๋ฆฌ**
4254

43-
- API ๋ฌธ์„œํ™” : **Postman**
44-
- ์ด์Šˆ ๊ด€๋ฆฌ : **Github Issue**
45-
- ์ปค๋ฎค๋‹ˆ์ผ€์ด์…˜ : **Slack / Gather / Notion**
46-
- **Git / Github**
55+
- **Github Issue** ์œผ๋กœ ์ด์Šˆ๋ฅผ ๊ด€๋ฆฌํ•ด์š”.
56+
- **Git-flow ์ „๋žต**์„ ์‚ฌ์šฉํ•˜์—ฌ ๋ธŒ๋žœ์น˜๋ฅผ ๊ด€๋ฆฌํ•ด์š”.
57+
- **Slack / Gather / Notion** ์œผ๋กœ ์†Œํ†ตํ•ด์š”.
58+
- **Postman** ์œผ๋กœ ์ž‘์„ฑํ•œ API ๋ฌธ์„œ๋ฅผ ํ†ตํ•ด ํด๋ผ์ด์–ธํŠธ์™€ ์†Œํ†ตํ•ด์š”.
4759

4860
**CI/CD**
4961

50-
- **Jenkins**
62+
- **Github Actions** ๋กœ ์ฝ”๋“œ ํ€„๋ฆฌํ‹ฐ์™€ ํ…Œ์ŠคํŠธ๋ฅผ ๊ฒ€์‚ฌํ•ด์š”.
63+
- **Jenkins** ๋กœ ๋ฐฑ์—”๋“œ ์ฝ”๋“œ์˜ ์ง€์†์ ์ธ ๋ฐฐํฌ๋ฅผ ์ง„ํ–‰ํ•ด์š”.
64+
- **Codacy** ๋กœ ์ง€์†์ ์ธ ์ฝ”๋“œ ํ€„๋ฆฌํ‹ฐ ๊ฐœ์„ ์„ ์ง„ํ–‰ํ•ด์š”.
65+
- **JACOCO** ๋กœ ํ…Œ์ŠคํŠธ ์ปค๋ฒ„๋ฆฌ์ง€๋ฅผ ๊ฒ€์‚ฌํ•ด์š”.
5166

52-
**Dependencies**
67+
**Security**
5368

54-
- Spring Web
55-
- Spring Data JPA
56-
- H2 Database
57-
- Spring REST Docs
58-
- Lombok
69+
- **Spring Security** ๋ฅผ ์‚ฌ์šฉํ–ˆ์–ด์š”.
70+
- ๋กœ๊ทธ์ธ ์‹œ์—๋Š” **JWT** ํ† ํฐ์„ ๋ฐœํ–‰ํ•˜์—ฌ ์„œ๋ฒ„์˜ ๋ณ„๋„ ์ €์žฅ์†Œ ์—†์ด ๋กœ๊ทธ์ธ์„ ์œ ์ง€ํ•  ์ˆ˜ ์žˆ์–ด์š”.
71+
- CertBot ์œผ๋กœ Letโ€™s Encrypt **SSL** ์ธ์ฆ์„œ๋ฅผ ๋ฐœ๊ธ‰๋ฐ›์•˜์–ด์š”.
72+
- **Nginx** ๊ฐ€ ํ”„๋ก์‹œ๋กœ 8080 ํฌํŠธ๋ฅผ ๋ฐ”๋ผ๋ณด๊ฒŒ ์„ค์ •ํ–ˆ์–ด์š”.
5973

60-
## ๐Ÿ—๏ธ์„ค๊ณ„
74+
<br>
75+
76+
## โš™์‹œ์Šคํ…œ ์•„ํ‚คํ…์ฒ˜
77+
![์ตœ์ข…](https://user-images.githubusercontent.com/55528172/147193318-77fd4086-33a1-4e71-aa46-2f36a474eff1.png)
6178

62-
[MoSCoW ๋งํฌ](https://www.notion.so/MoSCoW-4f7d9e241bc24e84ac7c8213ef1d2c85)
79+
<br>
6380

81+
## ๐Ÿ—๏ธ์„ค๊ณ„
6482
### ERD ์„ค๊ณ„
83+
![Untitled](https://user-images.githubusercontent.com/55528172/147193431-1410ff56-67b9-4eee-ba16-1b0a3a60c447.png)
84+
85+
86+
### ์„ค๊ณ„ ๋ฌธ์„œ
87+
[๐Ÿ„MoSCoW ๊ตฌ๊ฒฝ๊ฐ€๊ธฐ](https://www.notion.so/MoSCoW-4f7d9e241bc24e84ac7c8213ef1d2c85)<br>
88+
[๐Ÿ”SURF API ์„ค๊ณ„ ๊ตฌ๊ฒฝ๊ฐ€๊ธฐ](https://www.notion.so/6785f7446eba4a0b82d384d025cb28a6)<br>
89+
[๐Ÿ“‘Postman API ๋ช…์„ธ์„œ](https://documenter.getpostman.com/view/15409285/UVRAJnUD#50ff4a3f-1d02-4f50-9870-9c0b22fa2a6f)<br>
90+
91+
<br>
92+
93+
## ๐Ÿคณ๋ฐ๋ชจ ํ™”๋ฉด
94+
| **๋กœ๊ทธ์ธ** | **๋ฉ”์ธ ํ™”๋ฉด** - Surf ์ฒซ ํŽ˜์ด์ง€ | **๋ฉ”์ธ ํ™”๋ฉด** - ํŠน์ • category ์„ ํƒ |
95+
| :---: | :---: | :---: |
96+
| ![๋กœ๊ทธ์ธ](https://user-images.githubusercontent.com/55528172/147193938-07d0547f-740b-428c-8ea6-25c8a6e85f3f.gif) | ![๋ฉ”์ธ ํŽ˜์ด์ง€ - ์ฒซ ํ™”๋ฉด](https://user-images.githubusercontent.com/55528172/147193958-a062bdb3-a82a-41a2-8d2c-dd4ecd9882ba.gif) | ![๋ฉ”์ธ ํŽ˜์ด์ง€ - ์นดํ…Œ๊ณ ๋ฆฌ ์„ ํƒ](https://user-images.githubusercontent.com/55528172/147193999-6313d4d4-fe2b-4842-9b07-f3fa86835d56.gif) |
6597

66-
![erd](https://user-images.githubusercontent.com/56287836/146503313-64862768-a1e1-4a94-8645-f5b423a41ddd.png)
98+
| **๊ฒŒ์‹œ๊ธ€ ์ž‘์„ฑ** | **๋ฌดํ•œ ์Šคํฌ๋กค** | **๋งˆ์ด ํŽ˜์ด์ง€** - ๋‚ด ์ •๋ณด ์ˆ˜์ • |
99+
| :---: | :---: | :---: |
100+
| ![ํฌ์ŠคํŠธ ์ƒ์„ฑ](https://user-images.githubusercontent.com/55528172/147194169-b8d17790-bb44-4275-87d1-77156fa48667.gif) | ![๋ฌดํ•œ ์Šคํฌ๋กค](https://user-images.githubusercontent.com/55528172/147194204-14e4475b-dc85-41b4-8995-8d91b7fe286a.gif) | ![๋งˆ์ด ํŽ˜์ด์ง€ - ์ •๋ณด ์ˆ˜์ •](https://user-images.githubusercontent.com/55528172/147194226-f3ae8cf6-1894-4420-88a1-e340d426fd25.gif) |
67101

68-
## ๐Ÿ› ๏ธ API ์„ค๊ณ„
102+
| **๋Œ€์‹œ๋ณด๋“œ** | **์นด๋“œ ํŽ˜์ด์ง€** | **์นด๋“œ ํŽ˜์ด์ง€** - ํ•ด๋‹น ์›”๋ณ„ ๊ธฐ๋ก ๋ฆฌ์ŠคํŠธ |
103+
| :---: | :---: | :---: |
104+
| ![๋Œ€์‹œ๋ณด๋“œ](https://user-images.githubusercontent.com/55528172/147194386-80912927-d4a4-4901-aea2-e241f62c775f.gif) | ![์นด๋“œ ํŽ˜์ด์ง€](https://user-images.githubusercontent.com/55528172/147194395-060842b6-9ad4-4ef5-a5ba-7d3904906833.gif) | ![์นด๋“œ ํŽ˜์ด์ง€ - ์›”๋ณ„ ๋ฆฌ์ŠคํŠธ](https://user-images.githubusercontent.com/55528172/147194403-0f9236bb-3ce1-445d-aca1-775cb26d8737.gif) |
105+
| ๋งˆ์ด ํŽ˜์ด์ง€์—์„œ ์ด๋™ | ์—ฐ๋„๋ณ„ ํ•„ํ„ฐ๋ง, ํ•ด๋‹น ๋‹ฌ์˜ ์ž‘์„ฑ ์ผ์ˆ˜ ํ™•์ธ ๊ฐ€๋Šฅ | ์นด๋“œ ์„ ํƒ์‹œ |
69106

70-
[๐Ÿ”SURF API ์„ค๊ณ„ ๊ตฌ๊ฒฝ๊ฐ€๊ธฐ](https://www.notion.so/6785f7446eba4a0b82d384d025cb28a6)
107+
___
71108

72109
## ๐ŸŒปํ”„๋ก ํŠธ ๊นƒ ๋ ˆํฌ
73110

74-
[๐Ÿ‘จโ€๐Ÿ’ปSURF Front Git Repo](https://github.com/prgrms-web-devcourse/Team_Ahpuh_Surf_FE)
111+
[๐Ÿ‘จโ€๐Ÿ’ป**SURF** Front Git Repository](https://github.com/prgrms-web-devcourse/Team_Ahpuh_Surf_FE)
75112

76113
## ๐ŸํŒ€ ๋…ธ์…˜
77114

78-
[๐Ÿ”SURF ํŒ€ ๋…ธ์…˜ ๊ตฌ๊ฒฝ๊ฐ€๊ธฐ](https://www.notion.so/8-Ah-puh-Surf-ccc0a5922b8e4f638d6e897b4eb575a6)
115+
[๐Ÿ”**SURF** ํŒ€ ๋…ธ์…˜ ๊ตฌ๊ฒฝ๊ฐ€๊ธฐ](https://www.notion.so/8-Ah-puh-Surf-ccc0a5922b8e4f638d6e897b4eb575a6)

0 commit comments

Comments
ย (0)