Skip to content

Commit 972790e

Browse files
authored
Revise README with project details and team info
Updated README to enhance project description and team introduction.
1 parent 1ab1000 commit 972790e

File tree

1 file changed

+67
-22
lines changed

1 file changed

+67
-22
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 67 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,74 @@
1-
# YEONDEUNG-BE (μ—°λ“± λ°±μ—”λ“œ)
1+
# πŸ•―οΈ μ—°λ“± - λ°±μ—”λ“œ λ ˆν¬μ§€ν† λ¦¬
2+
```textplain
3+
γ€” οΌΌβ”‚/ 〕 흩어진 μ—°λŒ€λ₯Ό μž‡λŠ” λ”°λœ»ν•œ λΆˆλΉ›
4+
( μ—° λ“± ) μ—°λŒ€ ν™œλ™ μ •λ³΄μ˜ λͺ¨λ“  것,
5+
"*. __ .*" μ§€κΈˆ λ°”λ‘œ [μ—°λ“±]μ—μ„œ ν™•μΈν•˜μ„Έμš”.
6+
```
7+
## νŒ€μ› μ†Œκ°œ
8+
| ν™μ„œν˜„ | κ³½ν•΄λ¦Ό | μ†‘μ„œν˜„ |
9+
|--------|--------|--------|
10+
| BE Lead | BE | BE |
11+
| [@SH38038038](https://github.com/SH38038038) | [@Tulipurple](https://github.com/Tulipurple) | [@Hiimynameiss](https://github.com/Hiimynameiss) |
12+
| <img src="https://avatars.githubusercontent.com/SH38038038" width="100"> | <img src="https://avatars.githubusercontent.com/Tulipurple" width="100"> | <img src="https://avatars.githubusercontent.com/Hiimynameiss" width="100">
213

14+
# μ‹œμŠ€ν…œ μ•„ν‚€ν…μ²˜
15+
```mermaid
16+
flowchart TD
17+
%% --- λ””μžμΈ μ‹œμŠ€ν…œ ---
18+
classDef edge fill:#E1F5FE,stroke:#01579B,stroke-width:2px
19+
classDef aws fill:#FFF3E0,stroke:#E65100,stroke-width:2px
20+
classDef logic fill:#F3E5F5,stroke:#7B1FA2,stroke-width:2px
21+
classDef data fill:#E8F5E9,stroke:#2E7D32,stroke-width:2px
22+
classDef ai fill:#E0F2F1,stroke:#00796B,stroke-width:2px,stroke-dasharray: 5 5
323
4-
## πŸš€ 개발 ν™˜κ²½ μ‹€ν–‰ 방법
24+
subgraph Global_Edge ["🌍 Layer 7: Frontend & Masking"]
25+
User(("πŸ‘€ User\n(Browser)"))
26+
FB_H["πŸ”₯ Firebase Hosting\n(Static Assets)"]:::edge
27+
FB_R["πŸ›‘οΈ Cloud Rewrites\n(API Masking Proxy)"]:::edge
28+
end
529
6-
이 ν”„λ‘œμ νŠΈλŠ” Docker Composeλ₯Ό μ‚¬μš©ν•˜μ—¬ λͺ¨λ“  개발 ν™˜κ²½μ„ 1λΆ„ μ•ˆμ— ꡬ좕할 수 μžˆμŠ΅λ‹ˆλ‹€.
30+
subgraph AWS_EC2 ["☁️ AWS Hardened Host (Docker Engine)"]
31+
direction TB
32+
33+
subgraph Security_Gate ["πŸ”’ Security Layer"]
34+
Cert_Bot["πŸ”’ Certbot\n(SSL Auto-Renewal)"]:::aws
35+
DuckDNS["πŸ¦† DuckDNS\n(DDNS Endpoint)"]:::aws
36+
end
737
8-
1. **Docker Desktop**을 μ„€μΉ˜ν•˜κ³  μ‹€ν–‰ν•©λ‹ˆλ‹€.
38+
subgraph Container_Mesh ["🐳 Isolated Docker Network"]
39+
direction TB
40+
subgraph App_Cluster ["🧠 Logic Tier"]
41+
Node_App["🧩 Node.js API\n(SSL Termination)"]:::logic
42+
AI_Logic["πŸ€– OpenAI Pipeline"]:::ai
43+
end
44+
45+
subgraph Data_Tier ["πŸ’Ύ Persistence Tier"]
46+
direction LR
47+
MySQL[("🐬 MySQL 8.0")]:::data
48+
Redis[("πŸ”΄ Redis Cache")]:::data
49+
ES[("πŸ”Ž Elasticsearch")]:::data
50+
end
51+
end
52+
end
953
10-
2. 이 μ €μž₯μ†Œ(repository)λ₯Ό `git clone` λ°›μŠ΅λ‹ˆλ‹€.
11-
```bash
12-
git clone https://github.com/Solux-WebBeing/yeondeung-BE.git
13-
```
54+
Gemini_API[("🧠 OpenAI API")]:::ai
1455
15-
3. **.env 파일 생성**
16-
`.env.example` νŒŒμΌμ„ λ³΅μ‚¬ν•˜μ—¬ `.env` νŒŒμΌμ„ λ§Œλ“­λ‹ˆλ‹€.
17-
```bash
18-
cp .env.example .env
19-
```
56+
%% --- 데이터 흐름 ---
57+
User -- "HTTPS / TLS 1.3" --> FB_H
58+
FB_H -- "Path Masking" --> FB_R
59+
FB_R == "Secure Tunnel" ==> DuckDNS
60+
61+
DuckDNS --> Node_App
62+
Cert_Bot -. "SSL Certificate" .-> Node_App
63+
64+
Node_App <--> AI_Logic
65+
AI_Logic -- "External Request" --> Gemini_API
66+
67+
Node_App <--> MySQL
68+
Node_App <--> Redis
69+
Node_App <--> ES
2070
21-
4. **.env 파일 μˆ˜μ •**
22-
방금 μƒμ„±ν•œ `.env` νŒŒμΌμ„ μ—΄μ–΄, λΉ„μ–΄μžˆλŠ” `DB_PASSWORD`와 `JWT_SECRET` 값을 (νŒ€μ› 간에 곡유된) μ‹€μ œ κ°’μœΌλ‘œ μ±„μ›Œλ„£μŠ΅λ‹ˆλ‹€. (λ…Έμ…˜ μ°Έκ³ )
23-
24-
5. **Docker μ»¨ν…Œμ΄λ„ˆ μ‹€ν–‰**
25-
```bash
26-
docker-compose up -d --build #μ½”λ“œ μˆ˜μ •μ‹œ λΉŒλ“œ ν•„μš” (μ½”λ“œ μˆ˜μ • 없이 κ·Έλƒ₯ ν™•μΈλ§Œ ν•„μš”ν•˜λ©΄ μ˜΅μ…˜ 제거)
27-
```
28-
29-
6. μ™„λ£Œ! λΈŒλΌμš°μ €μ—μ„œ `http://localhost:8000/api-docs`으둜 μ ‘μ†ν•˜μ„Έμš”. (swaggerμ—μ„œ api ν…ŒμŠ€νŠΈ κ°€λŠ₯)
71+
%% CI/CD
72+
GHA["βš™οΈ GH Actions"] -. "Deploy" .-> FB_H
73+
GHA -. "Docker Push/Up" .-> Node_App
74+
```

0 commit comments

Comments
Β (0)