Update README.md

Author: dietken1

README.md

@@ -1,201 +1,204 @@
-# 🚗 IsItempty 백엔드 개발 가이드
+# 🚗 IsItEmpty 백엔드
 
-이 문서는 IsItempty 백엔드 애플리케이션의 로컬 개발 환경 설정 및 실행 방법을 안내합니다.
+<div align="center">
+  <img src="./images/logo.png" alt="IsItEmpty Logo" width="400"/>
+  
+  > 🅿️ 실시간 주차장 빈자리 확인으로 주차 스트레스 해소!
+</div>
 
-## 📋 목차
+서울시 공공데이터를 활용한 실시간 주차장 빈자리 확인 서비스의 백엔드 시스템입니다.
 
-- [개발 환경 설정](#개발-환경-설정)
-- [애플리케이션 실행](#애플리케이션-실행)
-- [데이터베이스 연결 설정](#데이터베이스-연결-설정)
-- [환경 설정 파일](#환경-설정-파일)
-- [프로필 설정](#프로필-설정)
-- [API 테스트](#api-테스트)
-- [문제 해결](#문제-해결)
-- [프로젝트 구조](#프로젝트-구조)
-- [참고 자료](#참고-자료)
+## 💡 서비스 소개
 
-## 💻 개발 환경 설정
+IsItEmpty는 다음과 같은 문제를 해결하기 위해 만들어졌습니다:
 
-### 필수 요구사항
+- 🚫 불법 주정차로 인한 사회적 문제
+- 😫 주차 공간을 찾기 위한 불필요한 시간 낭비
+- 🌍 교통 체증과 환경 오염
 
-- ✅ JDK 17 이상
-- ✅ MySQL (SSH 터널링 방식 사용)
-- ✅ Git
-- ✅ Intellij IDE (권장)
+### 주요 기능
 
-### 프로젝트 클론
+1. 🔍 **실시간 주차장 정보**
+   - 서울시 시영주차장 실시간 정보 제공
+   - 빈자리 수, 운영 시간, 요금 정보 제공
+   - 위치 기반 주변 주차장 검색
 
-```bash
-git clone https://github.com/isitempty/backend.git
-cd backend
-```
-
-## 🚀 애플리케이션 실행
-
-### 1) IntelliJ IDEA에서 실행
-
-1. IntelliJ IDEA에서 프로젝트 열기
-2. `IsitemptyApplication.java` 실행 버튼 클릭
+2. 📸 **주차 단속 카메라 정보**
+   - 주차 단속 카메라 위치 정보 제공
+   - 단속 구역 안내
 
-### 2) 명령줄에서 실행
+3. 🚽 **편의시설 정보**
+   - 주차장 내 화장실 위치
+   - 장애인 편의시설 정보
 
-```bash
-./gradlew bootRun
-```
+4. ⭐ **사용자 맞춤 기능**
+   - 즐겨찾기 주차장 등록
+   - 리뷰 및 평점 시스템
+   - 주차장 이용 내역 관리
 
-## 🔌 데이터베이스 연결 설정
+5. 👑 **관리자 기능**
+   - 사용자 관리 (조회/수정/삭제)
+   - 권한 관리 (관리자/일반 사용자)
+   - 문의사항 관리
+   - 시스템 모니터링
 
-### SSH 터널링을 통한 원격 데이터베이스 연결
-1. Bash 스크립트 파일에 권한 부여
-   ```bash
-   $ chmod +x mysql-tunnel.sh redis-tunnel.sh
-   ```
+## 🛠 기술 스택
 
-2. 터미널 2개를 열고 각각 Bash 스크립트 파일을 실행 후, 서버 비밀번호를 입력
-   ```bash
-   // Mysql
-   $ ./mysql-tunnel.sh
-   
-   // Redis
-   $ ./redis-tunnel.sh
-   ```
+- **언어 및 프레임워크**: 
+  - ![Java](https://img.shields.io/badge/Java-ED8B00?style=flat-square&logo=openjdk&logoColor=white) 
+  - ![Spring Boot](https://img.shields.io/badge/Spring_Boot-6DB33F?style=flat-square&logo=spring-boot&logoColor=white)
 
-> ✅ **SSH 터널링이 설정되면 애플리케이션은 원격 MySQL 및 Redis 서버에 연결됩니다.**
+- **데이터베이스**: 
+  - ![MySQL](https://img.shields.io/badge/MySQL-4479A1?style=flat-square&logo=mysql&logoColor=white)
+  - ![Redis](https://img.shields.io/badge/Redis-DC382D?style=flat-square&logo=redis&logoColor=white)
 
-## 🔐 환경 설정 파일
+- **인증/인가**: 
+  - ![OAuth2.0](https://img.shields.io/badge/OAuth2.0-2C5BB4?style=flat-square)
+  - ![JWT](https://img.shields.io/badge/JWT-000000?style=flat-square&logo=json-web-tokens&logoColor=white)
 
-### 애플리케이션 프로필
+- **빌드 및 배포**: 
+  - ![Gradle](https://img.shields.io/badge/Gradle-02303A?style=flat-square&logo=gradle&logoColor=white)
+  - ![Docker](https://img.shields.io/badge/Docker-2496ED?style=flat-square&logo=docker&logoColor=white)
+  - ![GitHub Actions](https://img.shields.io/badge/GitHub_Actions-2088FF?style=flat-square&logo=github-actions&logoColor=white)
 
-프로젝트는 Spring Boot의 프로필 기능을 사용하여 환경별 설정을 관리합니다:
+## 📐 시스템 아키텍처
 
-1. **application.properties**: 공통 설정
-2. **application-dev.properties**: 개발 환경 설정 (민감 정보 포함)
-3. **application-prod.properties**: 운영 환경 설정
+### 전체 구조
+```
+isitempty_backend/
+├── src/
+│   ├── main/
+│   │   ├── java/
+│   │   │   └── com.isitempty/
+│   │   │       ├── backend/
+│   │   │       │   ├── camera/        # 단속 카메라 관리
+│   │   │       │   ├── favorite/      # 즐겨찾기 기능
+│   │   │       │   ├── oauthlogin/    # 소셜 로그인
+│   │   │       │   ├── parkinglot/    # 주차장 관리
+│   │   │       │   ├── question/      # 문의사항
+│   │   │       │   ├── review/        # 리뷰 시스템
+│   │   │       │   └── toilet/        # 화장실 정보
+│   │   │       └── config/            # 시스템 설정
+│   │   └── resources/                 # 리소스 파일
+│   └── test/                          # 테스트 코드
+└── build.gradle                       # 빌드 설정
+```
 
-### 개발 환경 설정하기
+### 주요 컴포넌트
 
-1. `src/main/resources/application-dev.properties.example` 파일을 복사하여 같은 위치에 `application-dev.properties` 파일을 생성합니다.
-2. 생성한 파일에서 다음 설정값을 실제 값으로 변경합니다:
-   ```properties
-   # 개발 환경 설정
+1. 🔐 **인증/인가 시스템**
+   - OAuth2.0 기반 소셜 로그인 (Google, Naver, Kakao)
+   - JWT 토큰 기반 인증
+   - 사용자 권한 관리 (USER, ADMIN)
 
-   # MySQL
-   spring.datasource.url=
-   spring.datasource.username=
-   spring.datasource.password=
-   
-   # Redis
-   spring.data.redis.host=
-   spring.data.redis.port=
-   spring.data.redis.password=
-   
-   # 서울시 API 키
-   seoul.key=
-   
-   # SSH 터널링 설정
-   ssh.host=
-   ssh.port=
-   ssh.username=
-   ssh.password=
-   ssh.remote.host=
-   ssh.remote.port=
-   ssh.local.port=
-   ssh.enabled=
-   
-   # Redis 터널링 설정
-   ssh.redis.remote.host=
-   ssh.redis.remote.port=
-   ssh.redis.local.port=
-   ```
+2. 🅿️ **주차장 관리 시스템**
+   - 실시간 주차장 정보 조회
+   - 주차장 검색 및 필터링
+   - 즐겨찾기 기능
 
-> **중요**: `application-dev.properties` 파일은 `.gitignore`에 추가되어 있어 Git에 커밋되지 않습니다. .env의 역할을 한다고 생각하면 됩니다.
+3. ⭐ **리뷰 시스템**
+   - 주차장 리뷰 작성/수정/삭제
+   - 리뷰 평점 관리
 
-## 🔄 프로필(개발 환경)
+4. 💾 **데이터 캐싱**
+   - Redis를 활용한 실시간 데이터 캐싱
+   - 성능 최적화
 
-애플리케이션은 다음 프로필을 지원합니다:
+5. 🔒 **보안 설정**
+   - CORS 설정
+   - Spring Security 기반 보안 구성
+   - SSH 터널링 지원
 
-| 프로필 | 설명 |
-|--------|------|
-| `dev` | 개발 환경 (기본값) |
-| `prod` | 운영 환경 |
+## 🔌 API 엔드포인트
 
-## 🧪 API 테스트
+### 인증
+- 🔑 POST `/api/auth/login`: 로그인
+- ✨ POST `/api/auth/signup`: 회원가입
+- 👤 GET `/api/auth/me`: 현재 사용자 정보 조회
 
-애플리케이션이 실행되면 다음 URL로 API를 테스트할 수 있습니다:
+### 주차장
+- 📋 GET `/api/parkinglots`: 주차장 목록 조회
+- 🔍 GET `/api/parkinglots/{id}`: 특정 주차장 정보 조회
+- ⚡ GET `/api/parkinglots/realtime`: 실시간 주차장 정보 조회
 
-- 주차장 목록: [http://localhost:8080/api/parking-lots](http://localhost:8080/api/parking-lots)
+### 리뷰
+- ✏️ POST `/api/reviews`: 리뷰 작성
+- 📝 PUT `/api/reviews/{id}`: 리뷰 수정
+- 🗑️ DELETE `/api/reviews/{id}`: 리뷰 삭제
 
-## ⚠️ 문제 해결
+### 즐겨찾기
+- ⭐ POST `/api/favorites`: 즐겨찾기 추가
+- 💫 DELETE `/api/favorites/{id}`: 즐겨찾기 삭제
+- 📑 GET `/api/favorites`: 즐겨찾기 목록 조회
 
-### 1. SSH 터널링 오류
+### 관리자
+- 👥 GET `/api/admin/users`: 사용자 목록 조회
+- 🔄 PUT `/api/admin/users/{id}`: 사용자 정보 수정
+- 🗑️ DELETE `/api/admin/users/{id}`: 사용자 삭제
+- 👑 PATCH `/api/admin/users/{id}/role`: 사용자 권한 변경
 
-오류 메시지: `PortForwardingL: local port 3307 cannot be bound.`
+## ⚙️ 개발 환경 설정
 
-**[해결 방법]**
+1. 필수 요구사항
+   - ☕ JDK 17 이상
+   - 🐬 MySQL 8.0
+   - 🔄 Redis
+   - 🐳 Docker (선택사항)
 
-1. 이미 실행 중인 SSH 터널이 있는지 확인
-   ```bash
-   $ ps aux | grep ssh
+2. 환경변수 설정
+   ```properties
+   # application-dev.properties
+   spring.datasource.url=jdbc:mysql://localhost:3306/isitempty
+   spring.datasource.username=your_username
+   spring.datasource.password=your_password
+   
+   spring.data.redis.host=localhost
+   spring.data.redis.port=6379
+   spring.data.redis.password=your_redis_password
+   
+   seoul.key=your_seoul_api_key
    ```
 
-2. 다른 프로세스가 3307 포트를 사용 중인지 확인
+3. 빌드 및 실행
    ```bash
-   $ lsof -i :3307
+   # 프로젝트 빌드
+   ./gradlew build
+   
+   # 애플리케이션 실행
+   ./gradlew bootRun
    ```
 
-3. 다른 로컬 포트 사용 (예: 3308)
+4. Docker 실행
    ```bash
-   $ ssh -L 3307:172.19.0.3:3306 [email protected]
+   # Docker 이미지 빌드
+   docker build -t isitempty-backend .
+   
+   # Docker 컨테이너 실행
+   docker-compose up
    ```
 
-### 2. 데이터베이스 연결 오류
+## 🚀 배포
 
-오류 메시지: `Communications link failure`
+GitHub Actions를 통한 자동 배포가 구성되어 있습니다:
+1. main 브랜치에 push 시 자동 빌드
+2. 테스트 실행
+3. Docker 이미지 빌드 및 푸시
+4. 운영 서버 배포
 
-**[해결 방법]**
+## 📊 모니터링
 
-1. SSH 터널이 활성화되어 있는지 확인
-   ```bash
-   ps aux | grep ssh
-   ```
-
-2. 데이터베이스 자격 증명이 올바른지 확인
-   ```bash
-   mysql -h 127.0.0.1 -P 3307 -u isitempty -p
-   ```
-
-## 📁 프로젝트 구조
+- 📝 로깅 레벨 설정을 통한 모니터링
+- 📈 실시간 데이터 처리 상태 모니터링
+- 🚨 에러 로깅 및 추적
 
-```
-backend/
-├── src/main/java/com/isitempty/
-│   ├── IsitemptyApplication.java      # 애플리케이션 진입점
-│   ├── config/
-│   │   ├── SshTunnelConfig.java       # SSH 터널링 설정
-│   │   ├── EnvTest.java               # 환경 변수 테스트
-│   │   └── EnvTest2.java              # 시스템 환경 변수 테스트
-│   └── backend/
-│       ├── hello/
-│       │   └── HelloController.java   # 테스트용 컨트롤러
-│       └── parkinglot/
-│           ├── controller/            # 주차장 API 컨트롤러
-│           ├── model/                 # 주차장 데이터 모델
-│           ├── repository/            # 주차장 데이터 접근 계층
-│           └── service/               # 주차장 비즈니스 로직
-├── src/main/resources/
-│   ├── application.properties         # 기본 애플리케이션 설정
-│   ├── application-dev.properties     # 개발 환경 설정
-│   └── application-prod.properties    # 운영 환경 설정
-└── scripts/
-    └── setup-ssh-tunnel.sh           # SSH 터널 설정 스크립트
-```
+## 📜 라이선스
 
-## 📚 참고 자료
+This project is licensed under the MIT License - see the LICENSE file for details
 
-- [Spring Boot 문서](https://docs.spring.io/spring-boot/docs/current/reference/html/)
-- [MySQL 문서](https://dev.mysql.com/doc/)
-- [SSH 터널링 가이드](https://www.ssh.com/academy/ssh/tunneling)
+## 📞 연락처
 
----
+프로젝트 관련 문의사항은 아래 채널을 통해 연락주세요:
 
-© 2025 IsItempty Team
+- 이메일: [email protected]
+- 웹사이트: https://isitempty.kr
+- GitHub: https://github.com/isitempty