Skip to content

Commit 37a37f0

Browse files
authored
Merge pull request #143 from Wedit-project/dyk-im-patch-1
[Documentation] README.md ์ตœ์ข…๋ณธ ์™„์„ฑ
2 parents 7ae58a6 + 417a937 commit 37a37f0

File tree

1 file changed

+209
-55
lines changed

1 file changed

+209
-55
lines changed

โ€ŽREADME.mdโ€Ž

Lines changed: 209 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,215 @@
1-
<div align=center>
1+
# <img src="https://github.com/user-attachments/assets/482c5290-cfb9-43de-8b27-34231914a92a" style="height: 1em; vertical-align: middle;"> Wedit
22

3-
# Wedit-Backend
3+
![แ„‘แ…ญแ„Œแ…ต](https://github.com/user-attachments/assets/38077619-6e54-4ef4-b17f-6facb597ef09)
44

5-
### UMC Wedit-Project ๋ฐฑ์—”๋“œ ๋ ˆํฌ์ง€ํ† ๋ฆฌ
6-
#### [๋ฐฑ์—”๋“œ ๋…ธ์…˜ ๋งํฌ](https://www.notion.so/Spring-16edb6b0994880d7ad84e491d7440f2c)
75

8-
## BE Members
9-
<img width="160px" src="https://avatars.githubusercontent.com/u/106726806?v=4"/> | <img width="160px" src="https://avatars.githubusercontent.com/u/106726806?v=4"/> | <img width="160px" src="https://avatars.githubusercontent.com/u/106726806?v=4"/> | <img width="160px" src="https://avatars.githubusercontent.com/u/106726806?v=4"/> |
10-
|:-----:|:-----:|:-----:|:-----:|
11-
|[๋™๊ตฌ (๊น€๋™์œค)](https://github.com/dyk-im)|[๋™๋™ (๊น€๋™์„ญ)](https://github.com/dogsub)|[์œ„์ฆˆ (์ด์Šฌ๊ธฐ)](https://github.com/leeseulgi0208)|[ํ™˜์ด (์ตœ๊ฒฝํ™˜)](https://github.com/KyunghwanChoi)|
12-
|๋ฆฌ๋“œ ๐Ÿ‘จ๐Ÿปโ€๐Ÿ’ป|ํŒ€์› ๐Ÿ‘จ๐Ÿปโ€๐Ÿ’ป|ํŒ€์› ๐Ÿ‘จ๐Ÿปโ€๐Ÿ’ป|ํŒ€์› ๐Ÿ‘จ๐Ÿปโ€๐Ÿ’ป|
13-
|ํ™”์ดํŒ…!|ํ™”์ดํŒ…!!|ํ™”์ดํŒ…!!!|ํ™”์ดํŒ…!!!!|
14-
|`์ธํ”„๋ผ`<br/>|`์œ ์ €`<br/>|`๋ฉ”์ธ ๋„๋ฉ”์ธ`<br/>|`์„œ๋ธŒ ๋„๋ฉ”์ธ`<br/>|
6+
## ์„œ๋น„์Šค ์†Œ๊ฐœ
7+
<div align="left">
8+
<img src="https://github.com/user-attachments/assets/c1f238f8-b537-477f-9984-a5dd470f15b0" width="300">
9+
10+
11+
> ๊ฐœ๋ฐœ ๊ธฐ๊ฐ„: 2024. 1. 3 ~ 2025. 2. 21
12+
13+
**"Wedit: Wedding + Edit"**
14+
15+
๋””์ง€ํ„ธ๋กœ ๋งŒ๋‚˜๋Š” ๋‚˜๋งŒ์˜ ํŠน๋ณ„ํ•œ ์ปค์Šคํ…€ ๋ชจ๋ฐ”์ผ ์ฒญ์ฒฉ์žฅ
16+
17+
์˜ˆ๋น„ ๋ถ€๋ถ€๋“ค์ด ๋””์ง€ํ„ธ ํ™˜๊ฒฝ์—์„œ ์‰ฝ๊ณ  ๋น ๋ฅด๊ฒŒ ๊ฒฐํ˜ผ ์†Œ์‹์„ ์•Œ๋ฆฌ๊ณ ,
18+
์ž์‹ ๋งŒ์˜ ๊ฐœ์„ฑ์žˆ๋Š” ๋ชจ๋ฐ”์ผ ์ฒญ์ฒฉ์žฅ์„ ์ œ์ž‘ํ•  ์ˆ˜ ์žˆ๋„๋ก ๋•๋Š” ์›น ์„œ๋น„์Šค
1519

1620
</div>
17-
<br/>
18-
19-
## ๐Ÿ› ๏ธ Development Environment ๐Ÿ› ๏ธ
20-
![intellij](https://img.shields.io/badge/intellij-000000?style=for-the-badge&logo=intellijidea&logoColor=white)
21-
![aws](https://img.shields.io/badge/aws-FF9900?style=for-the-badge&logo=amazonec2&logoColor=white)
22-
23-
## ๐Ÿฅž Stacks ๐Ÿฅž
24-
| Name | Description |
25-
| ------------ | ------------- |
26-
| <img src="https://img.shields.io/badge/-Springboot-6DB33F?style=flat&logo=springboot&logoColor=white"> | Java ๊ธฐ๋ฐ˜ Spring ๋ฒ ์ด์Šค๋กœ ์„œ๋ฒ„ ํ”„๋กœ๊ทธ๋ž˜๋ฐ์„ ํ•  ์ˆ˜ ์žˆ๋Š” ํ”„๋ ˆ์ž„์›Œํฌ.|
27-
| <img src="https://img.shields.io/badge/-Git-F05032?style=flat&logo=git&logoColor=white"> | ๋ถ„์‚ฐ ๋ฒ„์ „ ๊ด€๋ฆฌ ์‹œ์Šคํ…œ์œผ๋กœ, ์ฝ”๋“œ ํžˆ์Šคํ† ๋ฆฌ ๊ด€๋ฆฌ์™€ ํ˜‘์—…์„ ํšจ์œจ์ ์œผ๋กœ ์ง€์›ํ•œ๋‹ค.|
28-
| <img src="https://img.shields.io/badge/-Notion-000000?style=flat&logo=notion&logoColor=white"> | ์ž‘์—… ๊ด€๋ฆฌ ๋ฐ ๋ฌธ์„œํ™”๋ฅผ ์œ„ํ•œ ํ†ตํ•ฉ ํ˜‘์—… ๋„๊ตฌ.|
29-
| <img src="https://img.shields.io/badge/-Discord-5865F2?style=flat&logo=discord&logoColor=white"> | ํŒ€ ์ปค๋ฎค๋‹ˆ์ผ€์ด์…˜ ๋ฐ ์‹ค์‹œ๊ฐ„ ํ˜‘์—…์„ ์œ„ํ•œ ์Œ์„ฑ ๋ฐ ํ…์ŠคํŠธ ๊ธฐ๋ฐ˜ ํ”Œ๋žซํผ.|
30-
31-
## ๐Ÿ’ป Convention ๐Ÿ’ป
32-
[๐Ÿ”— Whole Convention Notion Link ๐Ÿ”—](https://www.notion.so/Spring-16edb6b0994880d7ad84e491d7440f2c)
33-
34-
## ๐ŸŒฒ Branch Convention ๐ŸŒฒ
35-
1. **๊ธฐ๋ณธ ๋ธŒ๋žœ์น˜ ์„ค์ •**
36-
- main : ๋ฐฐํฌ ๊ฐ€๋Šฅํ•œ ์•ˆ์ •์ ์ธ ์ฝ”๋“œ๊ฐ€ ์œ ์ง€๋˜๋Š” ๋ธŒ๋žœ์น˜
37-
- develop: ๊ธฐ๋ณธ ๋ธŒ๋žœ์น˜๋กœ, ๊ธฐ๋Šฅ์„ ๊ฐœ๋ฐœํ•˜๋Š” ๋ธŒ๋žœ์น˜
38-
2. **์ž‘์—… ์ˆœ์„œ**
39-
1. **์ž‘์—…ํ•  ์ด์Šˆ ์ž‘์„ฑ**
40-
2. **์ž‘์—… ๋ธŒ๋žœ์น˜ ์ƒ์„ฑ**
41-
- ๊ธฐ๋Šฅ ๊ฐœ๋ฐœ: `feature/#[์ด์Šˆ๋ฒˆํ˜ธ]-title`
42-
- ex) feature/#111-login
43-
- ๋ฆฌํŒฉํ† ๋ง: `refactor/#[์ด์Šˆ๋ฒˆํ˜ธ]-title`
44-
- ex) refactor/#111-login
45-
3. **์ƒ์„ฑํ•œ ๋ธŒ๋žœ์น˜์—์„œ ์ž‘์—… ์ˆ˜ํ–‰**
46-
4. **์›๊ฒฉ ์ €์žฅ์†Œ์— ์ž‘์—… ๋ธŒ๋žœ์น˜ ํ‘ธ์‹œ**
47-
5. **Pull Request ์ƒ์„ฑ**
48-
---
49-
## ๐Ÿง‘โ€๐Ÿ’ป Code Convention ๐Ÿง‘โ€๐Ÿ’ป
50-
**๋„ค์ด๋ฐ ๊ทœ์น™**
51-
- **๋ณ€์ˆ˜/์ƒ์ˆ˜**: ์นด๋ฉœ์ผ€์ด์Šค (์˜ˆ: `userName`)
52-
- **ํด๋ž˜์Šค/๊ตฌ์กฐ์ฒด**: ํŒŒ์Šค์นผ์ผ€์ด์Šค (์˜ˆ: `UserProfile`)
53-
- **ํ•จ์ˆ˜/๋ฉ”์„œ๋“œ**: ๋™์‚ฌ๋กœ ์‹œ์ž‘ํ•˜๋ฉฐ ์นด๋ฉœ์ผ€์ด์Šค (์˜ˆ: `fetchData()`)
54-
55-
---
56-
## ๐Ÿ’ฌ Issue Convention ๐Ÿ’ฌ
57-
## ๐Ÿซท PR Convention ๐Ÿซธ
58-
## ๐Ÿ™ Commit Convention ๐Ÿ™
59-
## ๐Ÿ“ Foldering Convention ๐Ÿ“
60-
---
6121

22+
## ๐Ÿ‘ฅ ํŒ€์› ์†Œ๊ฐœ
23+
24+
### Project Manager
25+
26+
<table>
27+
<tr>
28+
<td align="center"><img src="https://github.com/cherry-p0p.png" width="160"></td>
29+
</tr>
30+
<tr>
31+
<td align="center"><a href="https://github.com/cherry-p0p">์ตœ๋ฆฌ์›</td>
32+
</tr>
33+
<tr>
34+
<td align="center">Project Manager / PO</td>
35+
</tr>
36+
</table>
37+
38+
### Designer
39+
40+
<table>
41+
<tr>
42+
<td align="center"><img src="https://github.com/user-attachments/assets/c7533101-92f2-4912-8ed5-bea417151579" width="160" height="160"></td>
43+
44+
</tr>
45+
<tr>
46+
<td align="center"><a href="">๊น€๋ฏผ์ง€</td>
47+
</tr>
48+
<tr>
49+
<td align="center">Designer</td>
50+
</tr>
51+
</table>
52+
53+
### Frontend
54+
55+
<table>
56+
<tr>
57+
<td align="center"><img src="https://github.com/ah-o-ng12.png" width="160"></td>
58+
<td align="center"><img src="https://github.com/lyn0719.png" width="160"></td>
59+
<td align="center"><img src="https://github.com/rhdmschdl.png" width="160"></td>
60+
</tr>
61+
<tr>
62+
<td align="center">๋ฉ”์ธ/๋กœ๊ทธ์ธ ํŽ˜์ด์ง€</td>
63+
<td align="center">์ œ์ž‘/๋กœ๋”ฉ ํŽ˜์ด์ง€</td>
64+
<td align="center">์กฐํšŒ/์ž‘์„ฑ ํŽ˜์ด์ง€</td>
65+
</tr>
66+
<tr>
67+
<td align="center"><a href="https://github.com/ah-o-ng12">์ด์•„์˜</td>
68+
<td align="center"><a href="https://github.com/lyn0719">์ด์˜ˆ๋‚˜</td>
69+
<td align="center"><a href="https://github.com/rhdmschdl">์ตœ๊ณ ์€</td>
70+
</tr>
71+
<tr>
72+
<td align="center">FE Lead</td>
73+
<td align="center">FE</td>
74+
<td align="center">FE</td>
75+
</tr>
76+
</table>
77+
78+
### Backend
79+
80+
<table>
81+
<tr>
82+
<td align="center"><img src="https://github.com/dyk-im.png" width="160"></td>
83+
<td align="center"><img src="https://github.com/dogsub.png" width="160"></td>
84+
<td align="center"><img src="https://github.com/leeseulgi0208.png" width="160"></td>
85+
<td align="center"><img src="https://github.com/KyunghwanChoi.png" width="160"></td>
86+
</tr>
87+
<tr>
88+
<td align="center"><a href="https://github.com/ehs208">๊น€๋™์œค</td>
89+
<td align="center"><a href="https://github.com/seokjun01">๊น€๋™์„ญ</td>
90+
<td align="center"><a href="https://github.com/dyk-im">์ด์Šฌ๊ธฐ</td>
91+
<td align="center"><a href="https://github.com/jj0526">์ตœ๊ฒฝํ™˜</td>
92+
</tr>
93+
<tr>
94+
<td align="center">์ธํ”„๋ผ/์ •๋ณด์กฐํšŒ</td>
95+
<td align="center">ํšŒ์›</td>
96+
<td align="center">์ฒญ์ฒฉ์žฅ</td>
97+
<td align="center">๋ฐฉ๋ช…๋ก/์˜์‚ฌ๊ฒฐ์ •</td>
98+
</tr>
99+
<tr>
100+
<td align="center">BE Lead</td>
101+
<td align="center">BE</td>
102+
<td align="center">BE</td>
103+
<td align="center">BE</td>
104+
</tr>
105+
</table>
106+
107+
## ๐Ÿ“ฑ ์ฃผ์š” ๊ธฐ๋Šฅ
108+
109+
- **์ปค์Šคํ…€ ์ฒญ์ฒฉ์žฅ ์ œ์ž‘**
110+
<img width="1449" alt="แ„‰แ…ณแ„แ…ณแ„…แ…ตแ†ซแ„‰แ…ฃแ†บ 2025-03-17 แ„‹แ…ฉแ„’แ…ฎ 5 05 40" src="https://github.com/user-attachments/assets/3e0d4b82-2edf-4c70-9391-ca914c687956" />
111+
112+
- **ํ…Œ๋งˆ ์ฒญ์ฒฉ์žฅ ์„ ํƒ (๊ธฐ๋ณธํ˜•)**
113+
<img width="1449" alt="แ„‰แ…ณแ„แ…ณแ„…แ…ตแ†ซแ„‰แ…ฃแ†บ 2025-03-17 แ„‹แ…ฉแ„’แ…ฎ 5 08 41" src="https://github.com/user-attachments/assets/ca9708cb-2934-48a7-83f9-e84a74e73f3b" />
114+
115+
116+
- **ํ…Œ๋งˆ ์ฒญ์ฒฉ์žฅ ์„ ํƒ (์ „ํ†ตํ˜•)**
117+
<img width="1447" alt="แ„‰แ…ณแ„แ…ณแ„…แ…ตแ†ซแ„‰แ…ฃแ†บ 2025-03-17 แ„‹แ…ฉแ„’แ…ฎ 5 08 53" src="https://github.com/user-attachments/assets/6fa3cd6d-b4a2-4a1b-ab5f-12a5f0ad4554" />
118+
119+
- **IA**
120+
<img width="682" alt="แ„‰แ…ณแ„แ…ณแ„…แ…ตแ†ซแ„‰แ…ฃแ†บ 2025-03-17 แ„‹แ…ฉแ„’แ…ฎ 5 08 23" src="https://github.com/user-attachments/assets/bb4de0aa-4938-4332-a0c5-6739979190cb" />
121+
122+
## ๐Ÿ’ป ํ™”๋ฉด
123+
124+
<table align="center" style="border-collapse: collapse; width: 100%; max-width: 1200px; margin: 20px;">
125+
<tr>
126+
<td align="center" style="width: 50%; padding: 10px;">
127+
<img src="https://github.com/user-attachments/assets/51d69616-e246-49a0-9883-413442fe98e5" alt="์ „ํ†ตํ˜• ์ฒญ์ฒฉ์žฅ" style="width: 100%; max-width: 500px;">
128+
</td>
129+
<td align="center" style="width: 50%; padding: 10px;">
130+
<img src="https://github.com/user-attachments/assets/85bb376e-4e9f-4baf-829d-91b09b8799e6" alt="๊ธฐ๋ณธํ˜• ์ฒญ์ฒฉ์žฅ" style="width: 100%; max-width: 500px;">
131+
</td>
132+
</tr>
133+
<tr>
134+
<td><p align="center"><strong>์ „ํ†ตํ˜• ์ฒญ์ฒฉ์žฅ</strong></p></td>
135+
<td><p align="center"><strong>๊ธฐ๋ณธํ˜• ์ฒญ์ฒฉ์žฅ</strong></p></td>
136+
</tr>
137+
<tr>
138+
<td align="center" style="width: 50%; padding: 10px;">
139+
<img src="https://github.com/user-attachments/assets/9553fa8c-5256-4c7c-b72d-fec2cbb13fc4" alt="์ œ์ž‘ํ•˜๊ธฐ 1" style="width: 100%; max-width: 500px;">
140+
</td>
141+
<td align="center" style="width: 50%; padding: 10px;">
142+
<img src="https://github.com/user-attachments/assets/d4154508-a0c4-4292-9fe1-20e7913f7a97" alt="์ œ์ž‘ํ•˜๊ธฐ 2" style="width: 100%; max-width: 500px;">
143+
</td>
144+
</tr>
145+
<tr>
146+
<td><p align="center"><strong>์ œ์ž‘ํ•˜๊ธฐ 1</strong></p></td>
147+
<td><p align="center"><strong>์ œ์ž‘ํ•˜๊ธฐ 2</strong></p></td>
148+
</tr>
149+
<tr>
150+
<td align="center" style="width: 50%; padding: 10px;">
151+
<img src="https://github.com/user-attachments/assets/b7f5f181-d947-444a-ac1f-80354a4f55f6" alt="๋งˆ์ดํŽ˜์ด์ง€" style="width: 100%; max-width: 500px;">
152+
<p align="center">
153+
</td>
154+
<td align="center" style="width: 50%; padding: 10px;">
155+
<img src="https://github.com/user-attachments/assets/c1337571-13a6-4801-91bb-5bdaa96b08a6" alt="๋ถ„์„ ๋ณด๊ธฐ" style="width: 100%; max-width: 500px;">
156+
<p align="center">
157+
</td>
158+
</tr>
159+
<tr>
160+
<td><p align="center"><strong>๋งˆ์ดํŽ˜์ด์ง€</strong></p></td>
161+
<td><p align="center"><strong>๋ถ„์„ ๋ณด๊ธฐ</strong></p></td>
162+
</tr>
163+
<tr>
164+
<td align="center" style="width: 50%; padding: 10px;">
165+
<img src="https://github.com/user-attachments/assets/4afa3e47-b00f-4d25-9e9c-07258e5d9ecc" alt="ํ™ˆ" style="width: 100%; max-width: 500px;">
166+
</td>
167+
<td align="center" style="width: 50%; padding: 10px;">
168+
<img src="https://github.com/user-attachments/assets/38e17d5d-4bf0-4ad5-9788-cbbe982ed73b" alt="๋กœ๊ทธ์ธ" style="width: 100%; max-width: 500px;">
169+
</td>
170+
</tr>
171+
<tr>
172+
<td><p align="center"><strong>ํ™ˆ</strong></p></td>
173+
<td><p align="center"><strong>๋กœ๊ทธ์ธ</strong></p></td>
174+
</tr>
175+
</table>
176+
177+
178+
## โš™๏ธ ์•„ํ‚คํ…์ฒ˜ ๊ตฌ์กฐ
179+
180+
<img width="1510" alt="แ„‰แ…ณแ„แ…ณแ„…แ…ตแ†ซแ„‰แ…ฃแ†บ 2025-03-17 แ„‹แ…ฉแ„’แ…ฎ 6 59 57" src="https://github.com/user-attachments/assets/89d08d7d-c5b7-4911-a015-ecc447dadc49" />
181+
182+
183+
## ๐Ÿ› ๏ธ ๊ธฐ์ˆ  ์Šคํƒ
184+
185+
### Frontend
186+
![React](https://img.shields.io/badge/React-61DAFB?style=flat&logo=react&logoColor=black)
187+
![Recoil](https://img.shields.io/badge/Recoil-3578E5?style=flat&logo=recoil&logoColor=white)
188+
![Vite](https://img.shields.io/badge/Vite-646CFF?style=flat&logo=vite&logoColor=white)
189+
190+
### Backend
191+
192+
![Spring Boot](https://img.shields.io/badge/Spring%20Boot-6DB33F?style=flat&logo=springboot&logoColor=white)
193+
![Spring Security](https://img.shields.io/badge/Spring%20Security-6DB33F?style=flat&logo=springsecurity&logoColor=white)
194+
![JPA](https://img.shields.io/badge/JPA-007396?style=flat&logo=hibernate&logoColor=white)
195+
![Redis](https://img.shields.io/badge/Redis-DC382D?style=flat&logo=redis&logoColor=white)
196+
![MySQL](https://img.shields.io/badge/MySQL-4479A1?style=flat&logo=mysql&logoColor=white)
197+
![JWT](https://img.shields.io/badge/JWT-000000?style=flat&logo=jsonwebtokens&logoColor=white)
198+
199+
### Infra
200+
201+
![AWS S3](https://img.shields.io/badge/AWS%20S3-569A31?style=flat&logo=amazons3&logoColor=white)
202+
![AWS EC2](https://img.shields.io/badge/AWS%20EC2-FF9900?style=flat&logo=amazonec2&logoColor=white)
203+
![AWS RDS](https://img.shields.io/badge/Amazon%20RDS-527FFF?style=flat&logo=amazonrds&logoColor=white)
204+
![Docker](https://img.shields.io/badge/Docker-2496ED?style=flat&logo=docker&logoColor=white)
205+
![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-2088FF?style=flat&logo=githubactions&logoColor=white)
206+
![Nginx](https://img.shields.io/badge/Nginx-009639?style=flat&logo=nginx&logoColor=white)
207+
![Netlify](https://img.shields.io/badge/Netlify-00C7B7?style=flat&logo=netlify&logoColor=white)
208+
![Certbot](https://img.shields.io/badge/Certbot-3A579A?style=flat&logo=letsencrypt&logoColor=white)
209+
210+
### Collaboration Tool
211+
![GitHub](https://img.shields.io/badge/GitHub-181717?style=flat&logo=github&logoColor=white)
212+
![Notion](https://img.shields.io/badge/Notion-000000?style=flat&logo=notion&logoColor=white)
213+
![Discord](https://img.shields.io/badge/Discord-5865F2?style=flat&logo=discord&logoColor=white)
214+
215+
</div>

0 commit comments

Comments
ย (0)