Skip to content

TeumTeumEat/TeumTeumEat-BackEnd

Repository files navigation

1024_500_graphic_image_2x image

📥 앱 다운로드

App Store Google Play


📑 목차

  1. 💡 About Project
  2. ✨ Key Features
  3. 🏗️ Architecture
  4. 🛠️ Tech Stack
  5. 💻 개발 환경 구축
  6. 🚀 CI/CD
  7. 👥 틈틈잇을 만든 사람들

💡 About Project

틈틈잇 TeumTeumEat은 무의미하게 흘려보내는 출퇴근/통학 자투리 시간을 성장의 기회로 바꿔주는 AI 기반 퀴즈 서비스입니다.
바쁜 현대인들이 따로 시간을 내지 않아도, 이동 시간에 딱 맞는 분량으로 지식을 섭취할 수 있도록 돕습니다.
사용자가 관심 있는 IT 주제를 선택하거나 전공 서적(PDF)을 업로드하면, AI가 이를 분석해 요약글, 퀴즈 형태로 가공하여 출근 시간마다 '냠냠 지식'을 배달해줍니다!

✨ Key Features

📚 1. AI 기반 맞춤형 학습 콘텐츠 생성

  • PDF 분석: 전공 서적이나 논문 PDF를 업로드하면 AI가 핵심 내용을 분석하여 일일 학습 분량으로 쪼개줍니다.
  • 카테고리 큐레이션: 프론트엔드, 백엔드 등 관심 분야를 설정하면 목표 기간동안 매일 새로운 지식이 제공됩니다.

🧩 2. 매일 도착하는 '냠냠 지식' & 퀴즈

  • 마이크로 러닝: 사용자가 설정한 이동 시간(3분/5분/7분)에 맞춰 부담 없는 분량의 요약본을 제공합니다.
  • 학습 확인: O/X 퀴즈나 객관식 문제를 통해 학습한 내용을 즉시 점검하고 히스토리에 보관합니다.

🐣 3. 학습 기록과 성장

  • 캐릭터 성장: 퀴즈를 풀고 지식을 먹여줄 때마다 '틈틈잇' 캐릭터의 기분이 좋아지고 배가 부른 모션으로 변합니다.
  • 스탬프 & 스트릭: 매일 학습을 완료하면 캘린더에 스탬프가 찍히며, 연속 학습(Streak)을 통해 성취감을 시각화합니다.
  • 푸시 알림: 사용자의 출퇴근 시간에 맞춰 "지금 숏츠 보고 있나요?"와 같은 센스 있는 알림으로 리마인드 해줍니다.

🏗️ Architecture

틈틈잇 아키텍처 구조(README)

🛠️ Tech Stack

iOS

Swift SwiftUI TCA Xcode iOS

Android

Kotlin

Backend

Java Spring Boot Spring Security Spring Data JPA MySQL Redis

Infrastructure & Deploy

Naver Cloud Docker Nginx GitHub Actions

External API & Services

AWS S3 AWS Lambda Firebase OpenAI Naver OCR

Monitoring & Tools

Prometheus Grafana Swagger


💻 개발 환경 구축

  • 본 프로젝트는 보안을 위해 민감한 설정값을 .env 파일로 관리합니다. 로컬 개발 환경을 구축하기 위해 아래 과정을 따라주세요.
    • 환경 변수 파일 생성
      • 루트 디렉토리의 .env.example 파일을 복사하여 .env 파일을 생성합니다.
      • 각 변수에 로컬 환경에 맞는 값을 입력합니다.
    • IDE 설정 (IntelliJ IDEA 기준)
      • EnvFile 플러그인을 설치합니다.
      • Run/Debug Configuration -> Edit Configuration -> Enable EnvFile, + 버튼 클릭하여 .env 파일을 추가합니다.
  • 관련 파일 : .env.example, application.yml

🚀 CI/CD

  • 환경 변수
    • Github Secret에 작성한 .env 파일을 Base64로 인코딩하여 ENV 변수로 등록합니다. (cat .env | base64 또는 base64encode.org 활용 )
  • 서버 접속 정보
    • 배포 서버의 HOST, PORT, USERNAME, PASSWORD(선택), KEY(선택), PASSPHRASE(선택), PROJECT_PATH 값을 입력합니다.
    • develop 브랜치에 코드가 Push되면 CI/CD가 진행됩니다.
  • 관련 파일 : ci.yml, cd.yml, docker-compose.yml, Dockerfile

👥 틈틈잇을 만든 사람들

PM 김주영 BE 김지민 BE 이효재
@kimjuyoung78 @jinnieusLab @hyotatoFrappuccino
AOS 강병수 iOS 임재현 Design 김은성 Design 이소민
@BPT0 @LimJaeHyeon9298 - -

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages