Skip to content

Commit fcaa4fd

Browse files
authored
πŸ“„ README 파일 μˆ˜μ •
1 parent a26e2d8 commit fcaa4fd

File tree

1 file changed

+38
-44
lines changed

1 file changed

+38
-44
lines changed

β€ŽREADME.md

+38-44
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,38 @@
1-
# Ivory-Backend
2-
3-
9oormthonUNIV 단풍톀 ν”„λ‘œμ νŠΈμ˜ λ°±μ—”λ“œ μ„œλ²„μž…λ‹ˆλ‹€.
4-
5-
---
6-
7-
## πŸš€ μ‹œμž‘ν•˜κΈ° (Getting Started)
8-
9-
### πŸ“‹ μš”κ΅¬μ‚¬ν•­ (Prerequisites)
10-
- **Java 17 이상**
11-
- **Spring Boot 3.0 이상**
12-
- **Maven 3.8+** λ˜λŠ” **Gradle 7.6+**
13-
- **MySQL 8.0 이상**
14-
- **Docker** (μ˜΅μ…˜)
15-
16-
---
17-
18-
### πŸ“ ν”„λ‘œμ νŠΈ μ„€μ • (Setup)
19-
20-
1. **μ½”λ“œ 볡제**
21-
```bash
22-
git clone https://github.com/9oormthon-univ/2024_DANPOONG_TEAM_15_BE.git
23-
cd 2024_DANPOONG_TEAM_15_BE
24-
```
25-
2. ν™˜κ²½ λ³€μˆ˜ μ„€μ •
26-
ν”„λ‘œμ νŠΈ 루트 디렉토리에 .env νŒŒμΌμ„ μƒμ„±ν•˜κ³  μ•„λž˜ λ‚΄μš©μ„ μΆ”κ°€ν•˜μ„Έμš”:
27-
```bash
28-
DB_URL=
29-
MYSQL_USER=
30-
MYSQL_PASSWORD=
31-
MYSQL_ROOT_PASSWORD=
32-
MYSQL_DATABASE=
33-
34-
JWT_SECRET_KEY=
35-
```
36-
---
37-
### 🐳 Docker둜 개발 ν™˜κ²½ μ‹€ν–‰ν•˜κΈ° (Using Docker)
38-
```bash
39-
docker-compose -f docker-compose.dev.yml up --build -d
40-
```
41-
---
42-
### πŸ” Swagger둜 API λ¬Έμ„œ ν™•μΈν•˜κΈ°
43-
- [http://localhost:8080/swagger-ui/index.html#](http://localhost:8080/swagger-ui/index.html#)
44-
---
1+
# 🍼 AI OCR 기반 μ§ˆλ³‘ 감염 아동 λŒλ΄„ μ„œλΉ„μŠ€ μ‹ μ²­ ν”Œλž«νΌ : 아이보리 (Ivory)
2+
3+
> μ•„μ΄λ³΄λ¦¬λŠ” 인곡지λŠ₯을 톡해 μ§ˆλ³‘κ°μ—Ό μ•„λ™λŒλ΄„ μ„œλΉ„μŠ€ 신청을 κ°„νŽΈν™”ν•˜λŠ” ν”Œλž«νΌμž…λ‹ˆλ‹€.
4+
>
5+
> 아이보리와 ν•¨κ»˜ μ•„μ΄λ“€μ—κ²Œ ν•„μš”ν•œ λŒλ΄„μ„ κ°€μž₯ λΉ λ₯΄κ³  κ°„νŽΈν•˜κ²Œ μ‹ μ²­ν•˜μ„Έμš”!
6+
> <br/>기술과 μ‚¬λžŒμ„ μž‡λŠ” μ•„μ΄λ³΄λ¦¬λ‘œ 더 λ‚˜μ€ λŒλ΄„ ν™˜κ²½μ„ λ§Œλ“€μ–΄κ°‘λ‹ˆλ‹€.
7+
8+
<img width="100%" src="https://github.com/user-attachments/assets/c9823cc8-30c7-448c-8df2-68ea2fbb0e63">
9+
10+
<br/><br/>
11+
12+
## 🍁 Developers
13+
14+
| PM | PD | FE | FE | BE | BE |
15+
| --- | --- | --- | --- | --- | --- |
16+
| <img style="width: 200px;" src="https://avatars.githubusercontent.com/u/97465078?v=4" /> | <img style="width: 200px;" src="https://avatars.githubusercontent.com/u/165301687?v=4"/> | <img style="width: 200px;" src="https://avatars.githubusercontent.com/u/90364700?v=4" /> | <img style="width: 200px;" src="https://avatars.githubusercontent.com/u/61930500?v=4" /> | <img style="width: 200px;" src="https://avatars.githubusercontent.com/u/100124081?v=4" /> | <img style="width: 200px;" src="https://avatars.githubusercontent.com/u/104489022?v=4" /> |
17+
| μ„±κ· κ΄€λŒ€ν•™κ΅ | ν•œμ„±λŒ€ν•™κ΅ | λ•μ„±μ—¬μžλŒ€ν•™κ΅ | μ„±κ· κ΄€λŒ€ν•™κ΅ | ν•œκ΅­κ³΅ν•™λŒ€ν•™κ΅ | ν•œμ„±λŒ€ν•™κ΅ |
18+
| κΉ€λ―Όμ„œ | κΆŒκΈ°λ‚¨ | κΉ€μ„œμœ€ | κΉ€νƒœκ±΄ | κ°•κΈ°ν™˜ | 이주연 |
19+
| [@daram62](https://github.com/daram62) | [@rlska0711](https://github.com/rlska0711) | [@pookey1104](https://github.com/pookey1104) | [@Taegon21](https://github.com/Taegon21) | [@GiHwan2](https://github.com/GiHwan2) | [@Juye0nLee](https://github.com/Juye0nLee) |
20+
21+
## πŸ“Œ μ„œλΉ„μŠ€ μ†Œκ°œ
22+
23+
![ᄋᅑ아보라 포스ᄐα…₯](https://github.com/user-attachments/assets/a3a0d4e1-3dfa-40c2-a577-fa576042b59a)
24+
25+
## πŸš€ μ£Όμš” κΈ°λŠ₯
26+
27+
<img width="100%" src="https://github.com/user-attachments/assets/6dab008b-a3f9-4c2c-8e0e-1d91787002cc">
28+
<img width="100%" src="https://github.com/user-attachments/assets/61b9a438-5dde-4d7f-9ca2-77af8024aefd">
29+
30+
## πŸ§‘β€πŸ’»Β μ‹œμŠ€ν…œ 아킀텍쳐
31+
32+
<img width="100%" src="https://github.com/user-attachments/assets/8992898a-422c-42f8-944b-b1e18b0bac96">
33+
34+
## πŸ“ΉΒ μ‹œμ—°
35+
36+
πŸ”—Β https://youtu.be/Oy47KT_CMrM?feature=shared
37+
38+
πŸ”—Β https://danpoong-ivory.vercel.app/

0 commit comments

Comments
Β (0)