README.md

VODLE

현재 자신의 위치에서 텍스트 및 음성으로 기록을 남기는 서비스입니다.
자신의 목소리로도 남길 수 있고 인기있는 목소리를 통해 변조하여 남길 수 있습니다.
https://play.google.com/store/apps/details?id=com.tes.vodleapp

VODLE 소개 및 (UCC+시연) 영상

✔ 소개

✔ UCC 영상

https://youtu.be/pMdBspfv96o

✔ 시연 영상

https://youtu.be/6GsL7m1SSGc

VODLE 서비스 화면

✔ 로그인

✔ 음성 조회하기

✔ 음성 기록 남기기

✔ 텍스트 기록 남기기

서비스 아키텍처

기술 스택

프론트

백앤드

AI

Infra

\

포팅 메뉴얼

포팅메뉴얼.pdf

👨‍👩‍👧 협업툴

✔ 버전 관리

✔ 개발 일정 관리

✔ 커뮤니케이션

컨벤션

Jira

• 포지션 에픽에 맞게 스토리 생성
• 동일 업무를 진행하는 경우 같은 업무를 스토리로 생성
• 스토리 포인트 기준은 1시간에 1점, 최대 4점까지 부여 가능
• 4시간 이상의 업무인 경우 작업을 분할하여 수행

Git

• Git Commit 사용자 등록은 한글 이름 세 글자로 지정

  사용자 이름 등록 - git config --global user.name "신영한"
  사용자 이메일 등록 - git config --global user.email "신영한@naver.com" 
  

• Git Commit 제목

  종류	내용
  feat	새로운 기능, 특징 추가
  fix	수정, 버그 수정
  docs	문서(README, Java Doc, Swagger 등)에 관련된 내용, 문서 수정
  style	코드 포맷, 세미콜론 누락, 코드 변경이 없을 경우 (코드 스타일)
  refactor	원래도 정상적으로 동작하던 것을 수정, 추가, 보완(결과는 그대로 코드 개선)
  chore	빌드 업무 수정, 패키지 매니저 수정
  test	테스트 코드 수정, 누락된 테스트를 추가할 때, 리팩토링 테스트 추가

• Git Commit 본문

  본문은 자유롭게 작성
  

• Git Commit 꼬리말

  종류	내용
  Fixes	이슈 수정 중
  Resolves	이슈 수정 중
  Ref	참고할 이슈
  Related to	해당 커밋과 관련된 이슈 번호

• Git Commit Message 예시

  // 제목
  feat: 로그인 기능 API 구현
  
  // 본문
  로그인 기능 API 구현
  
  UserController - 로그인 API 구현
   : Login 맵핑 메서드 구현
   : 전달 인자 - 사용자 정보를 담은 Dto
   : 반환 값 - X
  
  // 꼬리말 
  Related to: #48
  

Git Flow

Git flow 사용 브랜치

종류	브랜치 이름	용도
master	master	최종 브랜치
develop	AOS	안드로이드 배포 및 테스트
	BE	백엔드 배포 및 테스트
	AI	AI 배포 및 테스트
feature	[포지션]_[브랜치 종류]	기능 개발
fix		기능 수정 사항 적용
hotfix		긴급한 버그 수정
release		이번 출시 버전을 준비
refactor		기능 리팩토링

Git flow 순서

- 1.개발 시, 맡은 기능 별로 develop 하위에 feature 브랜치 생성
- 2.개발 완료 시, 해당 feature 브랜치를 상위 브랜치에 merge 수행
- 3.develop merge 수행시 파이프라인 연결로 배포 및 테스트 작업 진행
- 4.개발 완료 및 테스트 완료 시, master 브랜치로 merge 수행

Git branch 이름

- [포지션]_[브랜치 종류]/[관련 작업 내용]
- 예) AOS의 과일 생성 기능 구현 : AOS_feature/fruit_create
- 예) BE의 과일 생성 기능 리팩터링 : BE_refactor/fruit_create
- 예) AI의 과일 분류 기능 긴급 버그 수정 : AI_hotfix/fruite_classification

Git flow 이미지

팀원 역할

여창영 (팀장_프론트)

- 안드로이드 앱 개발 (JetPack Compose, Hillt, Retrofit)
- Naver 지도 커스텀, 마커 클러스터링 HLS 스트리밍 다이얼로그 개발
- Adoebe After Effect - 디자인 에셋 제작
- UCC 제작

정수현 (팀원_프론트)

- 안드로이드 앱 개발 (JetPack Compose, Hillt, Retrofit)
- 메인 화면 개발, 음성 등록 다이얼 로그 개발 
- 앱 아키텍처 설계

황찬준 (팀원_AI)

- AI 모델 개발 - STT, TTS, Conversion, Test Classification 구현
- AI 모델 서버 구축 - Google Cloud Platform 사용
- AI <-> BE 비동기 처리

신영한 (팀원_백엔드)

- 백엔드 서버 구축 및 관리 - Spring Boot, Swagger
- MySQL, JPA, ERD - 설계 및 구축
- 백엔드 API 개발 - (음성, 파일)
- AWS - 음성 파일 저장, 스트리밍 변환, 스트리밍 듣기, 자동화 처리

서현재 (팀원_백엔드)

- AI API 호출
- OpenFeign - AI 비동기 통신

이희웅 (팀원_인프라)

- 인프라 담당 - Docker, CI/CD(Jenkins), EC2 관리
- Spring Boot, Swagger - 백엔드 서버 구축 및 관리
- Spring Security (인증, 인가) - 로그인과 회원가입 수행
- 토큰 관리 - REDIS 사용 

산출물

시퀀스 다이어그램

화면 설계서

기능명세서

간트차트

🎨 ERD