1. 프로젝트 개요
2. 팀 소개
3. 주요 기능
4. 기술 스택
5. 아키텍처
6. 시연 사진
7. 설치 및 실행 방법
8. API 사용
9. 프로젝트 비전 및 향후 계획

"신한: 더 패밀리 가디언"은 가족을 각종 금융 위협으로부터 보호하기 위한, 보다 따뜻한 금융을 지향하는 가족 안심 서비스입니다. 보이스피싱, 스미싱, 무분별한 과소비 등 증가하는 금융 위협에 대응하여, 가족에 의해 직접적으로 구성원의 금융 안전을 보호하는 동시에, 각 구성원의 경제적 자립성을 증진시키는 것을 목표로 하고 있습니다.

팀명: 더 가디언즈

👑 안현욱(팀장): FE/BE - Payment Gateway, 결제 감지 및 승인/차단 기능

👨‍💻 이한주: BE - 문제은행 및 평가 시스템, 생성형 AI 챗봇 '가디'

👨‍💻 이준용: BE - 사용자 인증/인가, 그룹 시스템, 알림, Infrastructure 구성

🎨 현경찬: FE - 알림, 챗봇, 메인 페이지

🎨 조윤정: FE - 그룹, 설정, 시험 페이지

1. 🏠 패밀리 그룹 구성: 가디언과 서포터 역할을 통한 가족 금융 관리
2. 🛑 송금 차단: 보이스피싱 방지를 위한 현금 인출 및 계좌 이체 제한
3. 💳 결제 한도 설정: 하루/주간/월간 사용량 및 단건 결제 금액 제한
4. 👀 모니터링 및 알림: 한도를 초과한 인출 및 이체, 결제 시 알림
5. 📚 금융 학습 시스템: AI 챗봇을 활용한 금융 교육 및 가디언 자격 취득 지원
6. ⚡ 실시간 결제 감지: 진행되는 결제 탐지 및 가디언에 의한 승인/차단

• Frontend: TypeScript, React, Tailwind CSS, Zustand
• Backend: Java, Spring Boot, Spring Security, JPA
• Database: MySQL, Redis, MongoDB
• Notification: Firebase Cloud Messaging (FCM)
• Infrastructure: NginX, Docker, Jenkins
• Communication: Figma, Notion, Discord

사용자 친화적 디자인을 고려하여 설계하였습니다.

1. 저장소 클론

   git clone <https://github.com/your-repo/신한-더-패밀리-가디언.git>
   cd 신한-더-패밀리-가디언
   
   

2. 백엔드 설정 및 실행

   .env

   # DB
   MYSQL_HOST=${mysql host}
   MYSQL_PORT=${mysql port}
   MYSQL_DB=${mysql db name}
   MYSQL_USERNAME=${mysql username}
   MYSQL_PASSWORD=${mysql password}
   # Firebase
   FIREBASE_ADMIN_KEY_DIR=${firebase admin sdk path}
   FIREBASE_ADMIN_KEY_NAME=${firebase admin sdk name}
   FIREBASE_APP_NAME=${firebase app name}
   # API KEY
   API_KEY=${api key}
   USER_KEY=${user api key}
   # 1원 인증 API KEY
   COMPANY_AUTH_NAME=${custom auth name}
   # Gemini KEY
   PROJECT_ID=${google project id}
   LOCATION=${google project location}
   GOOGLE_APPLICATION_CREDENTIALS=${google app credentials}
   # Redis
   REDIS_HOST=${redis host}
   REDIS_PORT=${redis port}
   REDIS_PASSWORD=${redis password}
   # MongoDB
   MONGO_HOST=${mongo host}
   MONGO_PORT=${mongo port}
   MONGO_DATABASE=${mongo db name}
   

   # local
   cd backend
   ./gradlew clean build -x test
   java -jar ${jar file}
   
   
   # docker
   docker run --rm -it -d -p 8080:8080 -v ${local conf path}:${container conf path} --env-file ${.env file path}/.env --name guardian-backend yijy001/guardian-backend
   

3. 프론트엔드 설정 및 실행

   # local
   cd frontend
   npm install
   npm start
   
   # docker
   docker run --rm -it -d -p 80:80 -v ${local conf path}/default.conf:${container conf path}/default.conf yijy001/guardian-frontend
   

본 프로젝트는 다음과 같은 SSAFY 금융 API를 활용합니다.

1. 수시입출금
   • 계좌 생성
   • 계좌 조회
   • 계좌 잔액 조회
   • 계좌 출금
   • 계좌 입금
   • 계좌 이체
   • 계좌 이체 한도 변경
   • 계좌 거래 내역 조회
   • 계좌 거래 내역 조회(단건)
2. 인증
   • 1원 송금
   • 1원 송금 검증

"신한: 더 패밀리 가디언"은 가족의 금융 안전과 교육을 위한 종합 플랫폼으로 발전하고자 합니다. 우리의 비전과 계획은 다음과 같습니다.

• 금융 교육 콘텐츠 확장: 연령별, 상황별 맞춤형 금융 교육 콘텐츠 개발 및 제공
• 가족 금융 계획 도구 개발: 가족 구성원 전체의 재무 상태를 통합 관리하고 장기적인 재무 계획을 수립할 수 있는 도구 추가

안현욱	이한주	이준용	현경찬	조윤정