Skip to content

Commit 1cf7fcc

Browse files
authored
Update README.md
1 parent 5189f16 commit 1cf7fcc

1 file changed

Lines changed: 47 additions & 19 deletions

File tree

โ€ŽREADME.mdโ€Ž

Lines changed: 47 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@
44

55
---
66

7+
## โœจ Features
8+
9+
- ๋ชจ์ž„ ์ƒ์„ฑ
10+
11+
- ๋ชจ์ž„ ์ฐธ์—ฌ
12+
13+
- ์ถœ๋ฐœ์ง€ ๋“ฑ๋ก
14+
- ![Image](https://github.com/user-attachments/assets/7253df65-81b9-44e2-a611-b9d3253f70f5)
15+
16+
- ์ค‘๊ฐ„์ง€์  ๊ฒฐ๊ณผ๋ณด๊ธฐ
17+
18+
- ์žฅ์†Œ ์ถ”์ฒœ
19+
20+
---
21+
722
## ๐Ÿ›  Tech Stack
823

924
### Language
@@ -99,35 +114,48 @@
99114

100115
---
101116

102-
## โš™๏ธ Getting Started
117+
## ๐ŸŒ Deployment
103118

104-
### Prerequisites
119+
### ๐Ÿ— Service Architecture
120+
์ „์ฒด์ ์ธ ์‹œ์Šคํ…œ ๊ตฌ์กฐ๋Š” **Nginx**๋ฅผ ๋ฆฌ๋ฒ„์Šค ํ”„๋ก์‹œ๋กœ ํ™œ์šฉํ•˜๋ฉฐ, ์• ํ”Œ๋ฆฌ์ผ€์ด์…˜ ์„œ๋ฒ„์™€ ๋ฐ์ดํ„ฐ๋ฒ ์ด์Šค ๋ชจ๋‘ **Docker ์ปจํ…Œ์ด๋„ˆ**๋กœ ๋…๋ฆฝ ์šด์˜๋ฉ๋‹ˆ๋‹ค. ์„œ๋น„์Šค์˜ ์•ˆ์ •์ ์ธ ์šด์˜์„ ์œ„ํ•ด ๋กœ๊ทธ ๋ฐ์ดํ„ฐ๋Š” ํ˜ธ์ŠคํŠธ ์„œ๋ฒ„์™€ ๋ณผ๋ฅจ ๋งˆ์šดํŠธ๋ฅผ ํ†ตํ•ด ์˜๊ตฌ ๋ณด๊ด€๋ฉ๋‹ˆ๋‹ค.
105121

106-
- JDK 21
107-
- MariaDB (Local or Docker)
122+
* **Web Server**: Nginx (Reverse Proxy)
123+
* **Application Server**: Docker Containers (Spring Boot 3.x)
124+
* **Database**: Docker Container (MariaDB 10.11+)
125+
* **Log Management**: Host-Container Volume Mapping (`/logs`)
108126

109-
### Installation & Run
110-
111-
1. **Repository Clone**
127+
---
112128

113-
```bash
114-
git clone [https://github.com/SWYP-mingling/Backend.git](https://github.com/SWYP-mingling/Backend.git)
129+
### ๐Ÿ’ป Infrastructure Detail
130+
| Infrastructure | Detail |
131+
| :--- | :--- |
132+
| **Cloud** | **NCP (Naver Cloud Platform)** |
133+
| **Instance** | Micro Server (Ubuntu 22.04 LTS) |
134+
| **Database** | MariaDB 10.11 (Dockerized) |
135+
| **Container** | Docker, Docker-compose |
115136

116-
```
117-
118-
2. **Build**
137+
---
119138

120-
```bash
121-
./gradlew build
139+
### ๐Ÿš€ CI/CD Pipeline
140+
GitHub Actions์™€ NCP Container Registry๋ฅผ ์—ฐ๋™ํ•˜์—ฌ ๋ฐฐํฌ ์ž๋™ํ™”๋ฅผ ๊ตฌ์ถ•ํ–ˆ์Šต๋‹ˆ๋‹ค.
122141

123-
```
142+
1. **GitHub Actions**: `main` ๋ธŒ๋žœ์น˜์— ์ฝ”๋“œ Push ์‹œ ๋นŒ๋“œ ๋ฐ ํ…Œ์ŠคํŠธ ์ž๋™ ์ˆ˜ํ–‰
143+
2. **NCP Container Registry (NCR)**: ๋นŒ๋“œ๋œ ์ด๋ฏธ์ง€๋ฅผ NCP ์ „์šฉ ์ปจํ…Œ์ด๋„ˆ ์ €์žฅ์†Œ์— Push ๋ฐ ๊ด€๋ฆฌ
144+
3. **Deployment Flow**:
145+
* GitHub Actions์—์„œ ํ”„๋กœ์ ํŠธ ๋นŒ๋“œ (Gradle)
146+
* Docker ์ด๋ฏธ์ง€ ์ƒ์„ฑ ํ›„ **NCP Container Registry**๋กœ Push
147+
* ๋Œ€์ƒ ์„œ๋ฒ„์— SSH ์ ‘์† ํ›„ ์ตœ์‹  ์ด๋ฏธ์ง€ `pull` ๋ฐ `docker-compose` ์žฌ์‹คํ–‰
124148

125-
3. **Run Application**
149+
---
126150

127-
```bash
128-
./gradlew bootRun
151+
### ๐Ÿ’พ Log Management
152+
์ปจํ…Œ์ด๋„ˆ ์žฌ๋ฐฐํฌ ์‹œ์—๋„ ๊ณผ๊ฑฐ์˜ ์—๋Ÿฌ ๊ธฐ๋ก์„ ๋ณด์กดํ•˜๊ธฐ ์œ„ํ•ด ํ˜ธ์ŠคํŠธ ์„œ๋ฒ„์˜ ํŒŒ์ผ ์‹œ์Šคํ…œ๊ณผ ๋™๊ธฐํ™”ํ•˜์—ฌ ๊ด€๋ฆฌํ•ฉ๋‹ˆ๋‹ค.
129153

130-
```
154+
* **๋กœ๊ทธ ๋ณด๊ด€ ๊ฒฝ๋กœ**: `/home/ncp-user/mingling-logs` (Host) โ†” `/logs` (Container)
155+
* **๋กœ๊ทธ ํŒŒ์ผ ๊ตฌ์„ฑ**:
156+
* `error.log`: ๋ชจ๋“  **ERROR** ๋ ˆ๋ฒจ ๋กœ๊ทธ ๊ธฐ๋ก (์„œ๋น„์Šค ์žฅ์•  ์ถ”์ ์šฉ)
157+
* `warn.log`: **WARN** ์ด์ƒ ๋ ˆ๋ฒจ ๋กœ๊ทธ ๊ธฐ๋ก (์ž ์žฌ์  ๋ฌธ์ œ ๋ชจ๋‹ˆํ„ฐ๋ง์šฉ)
158+
* **๋ชจ๋‹ˆํ„ฐ๋ง**: ์„œ๋ฒ„ ํ„ฐ๋ฏธ๋„์—์„œ `tail -f` ๋ช…๋ น์–ด๋ฅผ ํ†ตํ•ด ์‹ค์‹œ๊ฐ„์œผ๋กœ ์‹œ์Šคํ…œ ์ƒํƒœ๋ฅผ ํ™•์ธํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
131159

132160
---
133161

0 commit comments

Comments
ย (0)