Skip to content

πŸ’° 2024 μ‹ ν•œμ€ν–‰ 해컀톀 ν”„λ‘œμ νŠΈ: 더 νŒ¨λ°€λ¦¬ κ°€λ””μ–Έ

Notifications You must be signed in to change notification settings

shinhan-hackathon-the-guardians/.github

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

29 Commits
Β 
Β 
Β 
Β 

Repository files navigation

μ‹ ν•œ: 더 νŒ¨λ°€λ¦¬ κ°€λ””μ–Έ (κ°€μ‘± 금육 μ•ˆμ‹¬ μ„œλΉ„μŠ€)

image

πŸ“Œ λͺ©μ°¨

  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

Architecture

image

image

UI/UX

μ‚¬μš©μž μΉœν™”μ  λ””μžμΈμ„ κ³ λ €ν•˜μ—¬ μ„€κ³„ν•˜μ˜€μŠ΅λ‹ˆλ‹€.

μŠ€ν”Œλž˜μ‹œ ν™”λ©΄ ν™”λ©΄ 3 ν™”λ©΄ 4 그룹원 μΆ”κ°€ ν™”λ©΄ ν™”λ©΄ 6 ν™”λ©΄ 7 ν™”λ©΄ 8 ν™”λ©΄ 9 μ•Œλ¦Ό ν™”λ©΄ ν™”λ©΄ 결제 ν™”λ©΄

Flow Chart

image

μ„€μΉ˜ 및 μ‹€ν–‰ 방법

  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
    

API μ‚¬μš©

λ³Έ ν”„λ‘œμ νŠΈλŠ” λ‹€μŒκ³Ό 같은 SSAFY 금육 APIλ₯Ό ν™œμš©ν•©λ‹ˆλ‹€.

  1. μˆ˜μ‹œμž…μΆœκΈˆ
    • κ³„μ’Œ 생성
    • κ³„μ’Œ 쑰회
    • κ³„μ’Œ μž”μ•‘ 쑰회
    • κ³„μ’Œ 좜금
    • κ³„μ’Œ μž…κΈˆ
    • κ³„μ’Œ 이체
    • κ³„μ’Œ 이체 ν•œλ„ λ³€κ²½
    • κ³„μ’Œ 거래 λ‚΄μ—­ 쑰회
    • κ³„μ’Œ 거래 λ‚΄μ—­ 쑰회(단건)
  2. 인증
    • 1원 μ†‘κΈˆ
    • 1원 μ†‘κΈˆ 검증

ν”„λ‘œμ νŠΈ λΉ„μ „ 및 ν–₯ν›„ κ³„νš

"μ‹ ν•œ: 더 νŒ¨λ°€λ¦¬ κ°€λ””μ–Έ"은 κ°€μ‘±μ˜ 금육 μ•ˆμ „κ³Ό κ΅μœ‘μ„ μœ„ν•œ μ’…ν•© ν”Œλž«νΌμœΌλ‘œ λ°œμ „ν•˜κ³ μž ν•©λ‹ˆλ‹€. 우리의 λΉ„μ „κ³Ό κ³„νšμ€ λ‹€μŒκ³Ό κ°™μŠ΅λ‹ˆλ‹€.

  • 금육 ꡐ윑 μ½˜ν…μΈ  ν™•μž₯: 연령별, 상황별 λ§žμΆ€ν˜• 금육 ꡐ윑 μ½˜ν…μΈ  개발 및 제곡
  • κ°€μ‘± 금육 κ³„νš 도ꡬ 개발: κ°€μ‘± ꡬ성원 μ „μ²΄μ˜ 재무 μƒνƒœλ₯Ό 톡합 κ΄€λ¦¬ν•˜κ³  μž₯기적인 재무 κ³„νšμ„ μˆ˜λ¦½ν•  수 μžˆλŠ” 도ꡬ μΆ”κ°€

Contact.

μ•ˆν˜„μš± μ΄ν•œμ£Ό μ΄μ€€μš© ν˜„κ²½μ°¬ μ‘°μœ€μ •

About

πŸ’° 2024 μ‹ ν•œμ€ν–‰ 해컀톀 ν”„λ‘œμ νŠΈ: 더 νŒ¨λ°€λ¦¬ κ°€λ””μ–Έ

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published