Skip to content

Commit

Permalink
Merge pull request #72 from Team-HMH/docs/#71-edit-readme
Browse files Browse the repository at this point in the history
docs - #71 readme ์ˆ˜์ •
  • Loading branch information
kseysh authored Jan 17, 2024
2 parents 6010e37 + c5b8163 commit a232e91
Showing 1 changed file with 11 additions and 40 deletions.
51 changes: 11 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,88 +2,59 @@
> 33th DO SOPT APPJAM :: HMH (ํ•˜๋ฉดํ•จ) <br>
> ํ”„๋กœ์ ํŠธ ๊ธฐ๊ฐ„ : 2023.12.17 ~ ing<br>
> <br>
โฐ ๋‹น์‹ ์˜ ์†Œ์ค‘ํ•œ ์‹œ๊ฐ„์„ ์œ„ํ•œ ๋””์ง€ํ„ธ ๋””ํ†ก์Šค<br/>
<br>
โฐ ์Šค๋งˆํŠธํฐ ์ค‘๋… ํƒˆ์ถœ, ๋„ˆ๋„ ํ•˜๋ฉด ํ•จ
<br>

![HMH](https://github.com/Team-HMH/HMH-Server/assets/69035864/b0c5045e-44a7-4616-b267-316120043558)

<br>
## ๐Ÿ“Œ Tech Stacks


- **Language** : Java (jdk-17)
- **Web application Framework** : Spring boot (3.2.1), Spring Data JPA
- **DataBase** : MySql (8.1.0)
- **DataBase** : MySql (8.1.0), Redis
- **Cloud/Infra** : Aws EC2, RDS, code deploy
- **web server** : Tomcat
- **Collaborative Tool** : Github
- **web server** : Tomcat, Nginx
- **Collaborative Tool** : Github, Slack, Notion
- **Version Control** : Git

<br/>

## ๐Ÿ–ค Developers




| ์ž„์ฃผ๋ฏผ | ๊น€์Šนํ™˜ |
| :-----------------------------------------------------: | :------------------------------------------------------------: |
| <img width="300" alt="image" src="https://github.com/Team-HMH/HMH-Server/assets/76610340/ea57f67f-adcb-4abc-a198-7b962e61a6bc"> | <img width="300" alt="image" src="https://github.com/SOPT-33-iOS-Team-1/SOPKATHON_33-Server/assets/86935274/b1308faa-06cb-4818-878e-aeb8e17ac14c"> |
| [jumining](https://github.com/jumining) | [kseysh](https://github.com/kseysh) |

<br/>

## ๐Ÿ™‹๐Ÿปโ€โ™€๏ธ ์—ญํ•  ๋ถ„๋‹ด


<div markdown="1">

- `์ฃผ๋ฏผ๐Ÿน` & `์Šนํ™˜๐Ÿค–`

| ๊ธฐ๋Šฅ๋ช… | ๋‹ด๋‹น์ž | ์™„๋ฃŒ ์—ฌ๋ถ€ |
| --------------- | ----------- | --------- |
| ํ”„๋กœ์ ํŠธ ์„ธํŒ… | ์Šนํ™˜๐Ÿค– | ์™„๋ฃŒ |
| EC2 ์„ธํŒ… | ์ฃผ๋ฏผ๐Ÿน | ์™„๋ฃŒ |
| RDS ์„ธํŒ… | ์ฃผ๋ฏผ๐Ÿน | ์™„๋ฃŒ |
| CI/CD ์„ธํŒ… | ์Šนํ™˜๐Ÿค– | ์™„๋ฃŒ |
| README ์ž‘์„ฑ | ์Šนํ™˜๐Ÿค– | ์™„๋ฃŒ |
| DB ์„ค๊ณ„ | ์ฃผ๋ฏผ๐Ÿน ์Šนํ™˜๐Ÿค– | ์™„๋ฃŒ |
| API ๋ช…์„ธ์„œ ์ž‘์„ฑ | ์ฃผ๋ฏผ๐Ÿน ์Šนํ™˜๐Ÿค– | ์™„๋ฃŒ |
| API ๊ฐœ๋ฐœ | ์ฃผ๋ฏผ๐Ÿน ์Šนํ™˜๐Ÿค– | ์ง„ํ–‰์ค‘ |

</div>

<br/>

## โœ… Convention



### ๐Ÿš€Convention

- [๐Ÿ’ป ํ˜‘์—… ์ปจ๋ฒค์…˜](https://msmmx.notion.site/6fa22000670d4cf783559f7808c01d1a?pvs=4) <br>
- [๐Ÿ’ป ํ˜‘์—… ์ปจ๋ฒค์…˜](https://hmhteam.notion.site/6fa22000670d4cf783559f7808c01d1a?pvs=4) <br>

### ๐Ÿš€ Branch Strategy

- [๐Ÿ’ป ๋ธŒ๋žœ์น˜ ์ „๋žต](https://msmmx.notion.site/9d8065b238c543b890ceeb9912966dd0?pvs=4)
- [๐Ÿ’ป ๋ธŒ๋žœ์น˜ ์ „๋žต](https://hmhteam.notion.site/9d8065b238c543b890ceeb9912966dd0?pvs=4)

<br/>

## ๐Ÿ’พ ERD

![image](https://github.com/Team-HMH/HMH-Server/assets/69035864/899d87a4-9262-47c4-9fc0-dc820a7f7189)



![image](https://github.com/Team-HMH/HMH-Server/assets/69035864/f4b95b3d-6507-4d33-be41-8a4847bc076f)

<br>

<br>

## โš™๏ธ Architecture

<img width="700" src="https://github.com/Team-HMH/HMH-Server/assets/76610340/825d260e-5a2e-494e-8abe-7299604b0bed">



![architecture](https://github.com/Team-HMH/HMH-Server/assets/69035864/e0eefac1-d8be-4a08-a3de-6e9786557042)


<br>
Expand Down

0 comments on commit a232e91

Please sign in to comment.