release

2025-06-19 09:58:49 +09:00 · 2025-06-19 09:58:49 +09:00 · 7de30c4b3a
commit 7de30c4b3a
parent 73f282e40c
1 changed files with 28 additions and 190 deletions
--- a/README.md
+++ b/README.md
@ -1,8 +1,8 @@
 # 마이구독 서비스 (LifeSub)

-
 ## 1. 소개
-마이구독은 다양한, 증가하는 생활 구독 서비스를 한 곳에서 편리하게 관리할 수 있는 애플리케이션입니다. 사용자가 구독 중인 서비스를 한눈에 확인하고, 월별 구독료를 관리하며, 새로운 구독 서비스를 추천받을 수 있습니다.
+마이구독은 다양한, 증가하는 생활 구독 서비스를 한 곳에서 편리하게 관리할 수 있는 애플리케이션입니다.   
+사용자가 구독 중인 서비스를 한눈에 확인하고, 월별 구독료를 관리하며, 새로운 구독 서비스를 추천받을 수 있습니다.  

 ### 1.1 핵심 기능
 - **구독 관리**: 다양한 구독 서비스를 한 곳에서 관리
@ -40,116 +40,8 @@
  - **Message Queue**: RabbitMQ
  - **기타**: Redis

-## 3. 프론트엔드 (lifesub-web)
-
-### 3.1 주요 화면
- **로그인 화면**: 사용자 인증
- **메인 대시보드**: 월별 구독료 및 구독 서비스 목록, 추천 카테고리 표시
- **구독 서비스 목록**: 카테고리별 구독 서비스 브라우징
- **구독 상세**: 구독 서비스 상세 정보 및 구독/취소 기능
-
-### 3.2 API 연동
-애플리케이션은 다음 백엔드 서비스와 API를 통해 통신합니다:
- `MEMBER_URL`: 인증 관련 API
- `MYSUB_URL`: 구독 관리 관련 API
- `RECOMMEND_URL`: 추천 관련 API
-
-## 4. 백엔드 서비스
-
-### 4.1 인증 서비스 (Member)
-회원 로그인 및 로그아웃, JWT 토큰 관리를 담당합니다.
-
-#### 4.1.1 주요 API
- `POST /login`: 로그인
- `POST /logout`: 로그아웃
-
-### 4.2 구독 서비스 (MySub)
-사용자의 구독 정보 관리 및 카테고리 관리를 담당합니다.
-
-#### 4.2.1 주요 API
- `GET /total-fee`: 총 구독료 조회
- `GET /list`: 사용자 구독 목록 조회
- `GET /services/{id}`: 구독 서비스 상세 조회
- `POST /services/{id}/subscribe`: 구독 신청
- `DELETE /services/{id}`: 구독 취소
- `GET /categories`: 카테고리 목록 조회
- `GET /services`: 카테고리별 서비스 조회
-
-### 4.3 추천 서비스 (Recommend)
-사용자의 지출 패턴 기반 구독 서비스를 추천합니다.
-
-#### 4.3.1 주요 API
- `GET /categories`: 추천 카테고리 조회
-
-## 5. 개발 환경 설정
-
-### 5.1 필수 요구사항
- Java 21 (백엔드)
- Node.js 20.x (프론트엔드)
- Docker 또는 Podman
- kubectl (Kubernetes CLI)
- Gradle (백엔드 빌드)
-
-### 5.2 프론트엔드 개발 환경 설정
-1. 저장소 클론
-   ```bash
-   git clone https://github.com/your-org/lifesub-web.git
-   cd lifesub-web
-   ```
-
-2. 의존성 설치
-   ```bash
-   npm install
-   ```
-
-3. 개발 서버 실행
-   ```bash
-   npm start
-   ```
-
-4. 환경 설정
-   프로젝트에서는 `public/runtime-env.js` 파일을 통해 런타임 환경 설정을 관리합니다:
-   ```javascript
-   window.__runtime_config__ = { 
-       MEMBER_URL: 'http://localhost:8081/api/auth', 
-       MYSUB_URL: 'http://localhost:8082/api/mysub', 
-       RECOMMEND_URL: 'http://localhost:8083/api/recommend' 
-   }
-   ```
-
-### 5.3 필요한 백킹 서비스 설치
-
-#### 5.3.1 PostgreSQL 데이터베이스 설치
-각 마이크로서비스는 별도의 PostgreSQL 데이터베이스를 사용합니다.
-
-1. Docker로 설치
-   ```bash
-   # Member 서비스용 DB
-   docker run -d --name member-postgres \
-     -e POSTGRES_DB=member \
-     -e POSTGRES_USER=admin \
-     -e POSTGRES_PASSWORD=Passw0rd \
-     -p 5432:5432 \
-     postgres:13.2-alpine
-
-   # MySub 서비스용 DB
-   docker run -d --name mysub-postgres \
-     -e POSTGRES_DB=mysub \
-     -e POSTGRES_USER=admin \
-     -e POSTGRES_PASSWORD=Passw0rd \
-     -p 5433:5432 \
-     postgres:13.2-alpine
-
-   # Recommend 서비스용 DB
-   docker run -d --name recommend-postgres \
-     -e POSTGRES_DB=recommend \
-     -e POSTGRES_USER=admin \
-     -e POSTGRES_PASSWORD=Passw0rd \
-     -p 5434:5432 \
-     postgres:13.2-alpine
-   ```
-
-2. Kubernetes Helm Chart로 설치
+## 3. 백킹 서비스 설치
+1. Database 설치  
   ```bash
   # Helm 저장소 추가
   helm repo add bitnami https://charts.bitnami.com/bitnami
@ -157,89 +49,36 @@

   # Member 서비스용 DB
   helm install member bitnami/postgresql \
-     --set global.postgresql.auth.postgresPassword=Passw0rd \
-     --set global.postgresql.auth.username=admin \
-     --set global.postgresql.auth.password=Passw0rd \
-     --set global.postgresql.auth.database=member
+      --set global.postgresql.auth.postgresPassword=Passw0rd \
+      --set global.postgresql.auth.username=admin \
+      --set global.postgresql.auth.password=Passw0rd \
+      --set global.postgresql.auth.database=member

   # MySub 서비스용 DB
   helm install mysub bitnami/postgresql \
-     --set global.postgresql.auth.postgresPassword=Passw0rd \
-     --set global.postgresql.auth.username=admin \
-     --set global.postgresql.auth.password=Passw0rd \
-     --set global.postgresql.auth.database=mysub
+      --set global.postgresql.auth.postgresPassword=Passw0rd \
+      --set global.postgresql.auth.username=admin \
+      --set global.postgresql.auth.password=Passw0rd \
+      --set global.postgresql.auth.database=mysub

   # Recommend 서비스용 DB
   helm install recommend bitnami/postgresql \
-     --set global.postgresql.auth.postgresPassword=Passw0rd \
-     --set global.postgresql.auth.username=admin \
-     --set global.postgresql.auth.password=Passw0rd \
-     --set global.postgresql.auth.database=recommend
+      --set global.postgresql.auth.postgresPassword=Passw0rd \
+      --set global.postgresql.auth.username=admin \
+      --set global.postgresql.auth.password=Passw0rd \
+      --set global.postgresql.auth.database=recommend
   ```

-#### 5.3.2 Message Queue 설치
+2. Message Queue 설치
+  설치 방법  
+  {MQ별 설치 방법 안내}

-### 5.4 백엔드 개발 환경 설정
-1. 저장소 클론
-   ```bash
-   git clone https://github.com/your-org/lifesub.git
-   cd lifesub
-   ```

-2. 의존성 설치 및 각 서비스 개별 빌드
-   ```bash
-   # 각 서비스 모듈을 개별적으로 빌드
-   ./gradlew :member:build
-   ./gradlew :mysub-infra:build
-   ./gradlew :recommend:build

-   # 또는 테스트 스킵 옵션으로 빌드
-   ./gradlew :member:build -x test
-   ./gradlew :mysub-infra:build -x test
-   ./gradlew :recommend:build -x test
-   ```
+## 4. 빌드 및 배포

-3. 각 서비스 실행
-   ```bash
-   # Member 서비스 실행
-   java -jar member/build/libs/member.jar
-
-   # MySub 서비스 실행 (mysub-biz는 라이브러리 모듈로 mysub-infra에 포함됨)
-   java -jar mysub-infra/build/libs/mysub.jar
-
-   # Recommend 서비스 실행
-   java -jar recommend/build/libs/recommend.jar
-   ```
-
-4. 환경 설정
-   각 서비스는 `application.yml` 파일에서 설정을 관리합니다. 기본 구성:
-   ```yaml
-   server:
-     port: 8081  # 각 서비스별로 다른 포트 사용
-   
-   spring:
-     datasource:
-       url: jdbc:postgresql://localhost:5432/member # 각 서비스별 DB 이름 변경 필요
-       username: admin
-       password: Passw0rd
-   
-   jwt:
-     secret-key: '8O2HQ13etL2BWZvYOiWsJ5uWFoLi6NBUG8divYVoCgtHVvlk3dqRksMl16toztDUeBTSIuOOPvHIrYq11G2BwQ'
-     access-token-validity: 3600000
-     refresh-token-validity: 86400000
-   
-   allowed-origins: http://localhost:3000
-   ```
-
-## 6. 빌드 및 배포
-
-### 6.1 프론트엔드 빌드 및 배포
-1. 애플리케이션 빌드
-   ```bash
-   npm run build
-   ```
-
-2. 컨테이너 이미지 빌드
+### 4.1 프론트엔드 빌드 및 배포
+1. 컨테이너 이미지 빌드
   ```bash
   docker build \
     --build-arg PROJECT_FOLDER="." \
@ -252,17 +91,17 @@
     -t {Image Registry주소}/lifesub/lifesub-web:latest .
   ```

-3. 이미지 푸시
+2. 이미지 푸시
   ```bash
   docker push {Image Registry주소}/lifesub/lifesub-web:latest
   ```

-4. Kubernetes 배포
+3. Kubernetes 배포
   ```bash
   kubectl apply -f deployment/manifest/
   ```

-### 6.2 백엔드 빌드 및 배포
+### 4.2 백엔드 빌드 및 배포
 1. 애플리케이션 빌드
   ```bash
   # 각 서비스 모듈을 개별적으로 빌드
@ -307,19 +146,18 @@
   kubectl apply -f deployment/manifest/
   ```

-### 6.3 로그인
+### 4.3 테스트 
 1) 프론트 페이지 주소 구하기   
 ```
 kubens {namespace}
-k get ing
+k get svc 
 ```

 2) 로그인 
 - ID: user01 ~ user05
 - PW: P@ssw0rd$

-
-## 7. 팀
+## 5. 팀

 - 오유진 "피오" - Product Owner
 - 강동훈 "테키" - Tech Lead