Skip to content

Commit 6dce8f6

Browse files
committed
📝 docs: readme
1 parent c956b82 commit 6dce8f6

1 file changed

Lines changed: 86 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 86 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,89 @@
1-
# WithTimeBE
2-
WithTime Web Service Backend REPO
1+
2+
# WithTime Backend
3+
4+
> 사용자의 예산과 취향에 맞춰 **맞춤형 데이트 코스**를 추천·공유하는 플랫폼의 백엔드 서버입니다.
5+
> Spring Boot 기반 REST API 서버로, AWS 인프라와 Redis 캐싱, JPA 최적화를 통해 안정적이고 빠른 서비스를 제공합니다.
6+
7+
---
8+
9+
## 📝 서비스 소개
10+
**WithTime**은 사용자가 원하는 예산과 본인의 취향을 입력하면,
11+
이에 맞춰 데이트 코스를 자동으로 구성하여 추천해주는 서비스입니다.
12+
추가로 날씨 기반 추천, 인기 키워드, 사용자 등급, 알림, 취향 테스트 등 다양한 기능을 제공합니다.
13+
14+
---
15+
16+
## 🛠 기술 스택
17+
18+
### Backend
19+
- **Java 17**
20+
- **Spring Boot 3.x**
21+
- Spring Data JPA, Spring Security, Validation
22+
- Swagger (Springdoc OpenAPI 3)
23+
- JWT 기반 인증/인가
24+
25+
### Database & Cache
26+
- **MySQL 8** (Amazon RDS)
27+
- **Redis (AWS ElastiCache)** – 캐시, 세션, 추천 데이터 임시 저장
28+
29+
### Infra & DevOps
30+
- **AWS EC2, S3, Route53, ElastiCache, RDS**
31+
- Docker / Docker Compose
32+
- GitHub Actions (CI/CD)
33+
- CloudWatch 모니터링
34+
35+
---
36+
37+
## 📌 주요 기능
38+
39+
### 1. 데이트 코스
40+
- 맞춤형 데이트 코스 생성 API
41+
- 코스 북마크 생성/삭제/조회
42+
- 코스 목록 조회 및 검색
43+
44+
### 2. 데이트 취향 테스트
45+
- 취향 테스트 진행 및 결과 조회
46+
- 잘 맞는 유형/안 맞는 유형 분석
47+
- 취향 데이터 초기화
48+
49+
### 3. 날씨 기반 추천
50+
- 지역별 주간 날씨 기반 추천
51+
- 강수확률 기반 추천
52+
- 관리자 수동 동기화 트리거
53+
54+
### 4. 사용자 관리
55+
- 회원가입 / 로그인 / 로그아웃
56+
- 소셜 로그인 (OAuth2)
57+
- 사용자 정보 수정/삭제
58+
- 비밀번호 변경, 이메일 인증
59+
- 회원 등급 조회
60+
61+
### 5. 공지사항 & FAQ
62+
- 공지사항 CRUD (관리자 전용)
63+
- 자주 묻는 질문 CRUD (관리자 전용)
64+
- 검색 및 상세 조회
65+
66+
### 6. 통계
67+
- 주간 인기 키워드
68+
- 월별 데이트 장소 등록 수
69+
- 내 데이트 횟수 vs 평균 횟수
70+
71+
### 7. 알림
72+
- 푸시 알림 발송 및 설정
73+
- 기기 토큰 업데이트
74+
- 알림 리스트 조회
75+
76+
---
77+
78+
## 🗂 API 문서
79+
Swagger UI: [https://api.withtime.cloud/swagger-ui/index.html](https://api.withtime.cloud/swagger-ui/index.html)
80+
OpenAPI Spec: [https://api.withtime.cloud/v3/api-docs](https://api.withtime.cloud/v3/api-docs)
81+
82+
---
83+
84+
## 📡 아키텍처
85+
86+
---
387

488
# 📋 Commit Message Convention (이모지 + 소문자 적용)
589
| Tag | Description |

0 commit comments

Comments
 (0)