Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/#7 mission readme (1μ°¨) #8

Merged
merged 2 commits into from
Nov 25, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 142 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,142 @@
# SOPKATHON_33-Server
Repository for Server
# SOPKATHON-33-Server

> 33th DO SOPT SOPKATHON :: **re:ing** <br>
>
> 33κΈ° 솝컀톀 iOS 1μ‘° ν”„λ‘œμ νŠΈ

<br>

## 🌼 μ„œλΉ„μŠ€ μ†Œκ°œ

---
### πŸ”₯ 이름
#### re:ing ( λ‹€μ‹œ μΌμƒμœΌλ‘œ, ν•¨κ»˜ κ±Έμ–΄κ°€λŠ” κΈΈ )

### πŸ”₯ μ†Œκ°œ
범죄 이λ ₯이 μžˆλŠ” μΆœμ†ŒμžλΌλ©΄, κ°±μƒλ˜μ§€ λͺ»ν•  κ²ƒμ΄λΌλŠ” λ‹Ήμ—°ν•œ μ‚¬νšŒμ  인식 μ†μ—μ„œ μš°λ¦¬λŠ” 그듀을 μ‚¬νšŒμ—μ„œ ν•¨κ»˜ ꡐ화될 수 μ—†λŠ” 쑴재둜 λ‹¨μ •μ§“λŠ” 관념을 가지고 μžˆλ‹€.<br/>
μ΄λŸ¬ν•œ μ‚¬νšŒμ  낙인은 λ²”μ£„μžλ“€μ΄ 방치되며 μž¬λ²”μœΌλ‘œ μ΄μ–΄μ§€λŠ” μ•…μˆœν™˜μ„ λ°˜λ³΅μ‹œν‚¨λ‹€. <br/>
λ”°λΌμ„œ μš°λ¦¬λŠ” μ΄λ“€μ˜ λ³€ν™” μ˜μ§€λ₯Ό 일으켜 일상을 νšŒλ³΅ν•˜λ„λ‘ 돕고, 더 λ‚˜μ€ μ‚¬νšŒλ₯Ό λ§Œλ“œλŠ” 것에 μ΄λ°”μ§€ν•˜λ € ν•œλ‹€.

<br/>

## πŸ“Œ Tech Stacks

---
- **Language** : Java (jdk-17)


- **Web application Framework** : Spring boot (3.2.0), Spring Data JPA


- **DataBase** : MySql (8.1.0)


- **Cloud/Infra** : Aws EC2, RDS, code deploy


- **web server** : Tomcat


- **Collaborative Tool** : Github


- **Version Control** : Git


<br/>


## πŸ–€ Developers

---
| μ •λ™κ·œ | κΉ€μŠΉν™˜ |
|:----:|:----:|
| <img width="300" alt="image" src="https://github.com/SOPT-33-iOS-Team-1/SOPKATHON_33-Server/assets/86935274/aa6b8ba8-f49c-45ad-bffd-69faa6703ca1"> | <img width="300" height="330" alt="image" src="https://github.com/SOPT-33-iOS-Team-1/SOPKATHON_33-Server/assets/86935274/b1308faa-06cb-4818-878e-aeb8e17ac14c">|
| [yummygyudon](https://github.com/yummygyudon) | [kseysh](https://github.com/kseysh) |

<br/>

## πŸ™‹πŸ»β€β™€οΈ μ—­ν•  λΆ„λ‹΄

---
<div markdown="1">

- `μŠΉν™˜πŸ€–` & `λ™κ·œπŸ£`

| κΈ°λŠ₯λͺ… | λ‹΄λ‹Ήμž | μ™„λ£Œ μ—¬λΆ€ |
| :-----: | :---: | :---: |
| ν”„λ‘œμ νŠΈ μ„ΈνŒ… | `μŠΉν™˜πŸ€–` | μ™„λ£Œ |
| EC2 μ„ΈνŒ… | `μŠΉν™˜πŸ€–` | μ™„λ£Œ |
| RDS μ„ΈνŒ… | `μŠΉν™˜πŸ€–` | μ™„λ£Œ |
| CI/CD μ„ΈνŒ… | `λ™κ·œπŸ£` | μ™„λ£Œ |
| README μž‘μ„± | `λ™κ·œπŸ£` | μ™„λ£Œ |
| DB 섀계 | `μŠΉν™˜πŸ€–` `λ™κ·œπŸ£` | 진행 쀑 |
| API λͺ…μ„Έμ„œ μž‘μ„± | `μŠΉν™˜πŸ€–` `λ™κ·œπŸ£` | 진행 μ˜ˆμ • |
| API 개발 | `μŠΉν™˜πŸ€–` `λ™κ·œπŸ£` | 진행 μ˜ˆμ • |

</div>


### ⭐️ 우리 μ‚¬λž‘ν•˜κΈ°λ‘œ ν–ˆμ–΄μš” ⭐️
(Comming Soon....) <br/>
<img width="550" height="400" alt="team_image" src="">


<br/>

## βœ… Convention

---
### πŸš€ Coding Convention
- [πŸ’» μ½”λ“œ μ»¨λ²€μ…˜](https://www.notion.so/Code-Convention-0616e03e9385444eaec6a446d3d6a757?pvs=4)

<br>

### πŸš€ Branch Strategy
- [πŸ’» 브랜치 μ „λž΅](https://www.notion.so/Branch-Strategy-19f824ec44124f478f38bed58ae517a2?pvs=4)

<br/>

## πŸ’Ύ ERD

---
> μžμ„Έν•œ ν…Œμ΄λΈ” μ •λ³΄λŠ” λ‹€μŒ λ…Έμ…˜ νŽ˜μ΄μ§€μ— μ •λ¦¬ν•΄λ‘˜ μ˜ˆμ •μž…λ‹ˆλ‹€! (Comming Soon...)
- [πŸ“ Database](Comming Soon...)

<img width="884" alt="erd_image" src="">

<br>

## πŸ–‡ Api λͺ…μ„Έμ„œ

---
> μž‘μ„± 쀑

[πŸ€ API λͺ…μ„Έμ„œ](https://www.notion.so/342f6504080f4113afb4a89af506c2d7?v=a36becbc1f0f4239a802053bf782195c&pvs=4)

<br>

## βš™οΈ Architecture

---
<img width="884" alt="architecture_image" src="">

<br>

## πŸ—‚οΈ Project Foldering

- **도메인 λ³„λ‘œ Architectureλ₯Ό λ‚˜λˆŒ μ˜ˆμ •μž…λ‹ˆλ‹€.**
```
```

<br>

## ♻️ μ‹€ν–‰ 방법

---


<br/>