🌸 REINPUT 🌸

아웃풋을 위한 인풋, 리-인풋

🏆 한국스마트정보교육원 24년 상반기 SW개발공모전 최우수상

🌸 프로젝트 소개

• 프로젝트 명 : REINPUT
• 프로젝트 설명 : 흩어져 있는 인사이트들을 리인풋이 제공하는 AI 인사이트 자동 분류로 인사이트를 체계적으로 관리하고, 리마인드 기능을 통해 인사이트를 주기적으로 상기시켜 인사이트를 활용해 보세요!

TechStack

Development Environment

Infra

CI/CD

🌸 기술 설명

기술 스택

• Spring Boot : Spring Boot를 사용하여 백엔드 서버 구축
• Spring Security : Spring Security를 사용하여 인증 및 권한 부여
• JWT : JWT를 사용하여 토큰 기반 인증 구현
• QueryDSL : QueryDSL을 사용하여 동적 쿼리 작성
• Swagger : Swagger를 사용하여 API 문서화
• AWS : AWS를 사용하여 서버 배포
• Docker : Docker 및 Docker Compose를 사용하여 컨테이너 관리 및 배포, 이미지 관리
• Github Actions : Github Actions를 사용하여 CI/CD 파이프라인 구축
• Nginx : Nginx를 사용하여 로드 밸런싱 및 리버스 프록시 구축
• RDS : RDS를 사용하여 MySQL 데이터베이스 구축
• S3 : S3를 사용하여 정적 파일 관리
• Route53 : Route53을 사용하여 도메인 관리
• IAM : IAM을 사용하여 AWS 리소스 접근 제어 및 보안 관리
• EC2 : EC2를 사용하여 서버 인스턴스 생성
• ALB : ALB를 사용하여 로드 밸런싱 및 http 프로토콜 https 리다이렉트 구현
• Gradle : Gradle을 사용하여 빌드 관리
• JPA : JPA를 사용하여 ORM 구현
• MySQL : 읽기 작업이 빈번하다는 점을 고려해 선택한 MySQL을 사용한 데이터베이스 구축
• 무중단배포 : Docker, Docker-Compose, Nginx, EC2, Target-groups, Application Load Balancer, AWS Certificate Manager, Route53, Github Action, Github Action Self-Hosted Runner, Gabia 를 사용한 Blue-Green 프리티어 무중단 배포 서버 파이프라인 구축 및 https 서비스 배포

Reinput Service Architecture

🌸 협업

• Git Branch 전략 : GitHub Flow 전략을 사용하여 개발
• DDD : 도메인 주도 개발 방식을 사용하여 개발
• Notion : 프로젝트 일정 및 문서화를 위해 Notion 사용
• Scrum : 매일 저녁 10시에 스크럼 진행

Git Branch 전략

• main : 배포 가능한 상태만을 관리하는 브랜치
• feat : 새로운 기능 개발 브랜치
• fix: 기능 수정 및 업데이트 브랜치
• test : 테스트 코드 작성 브랜치

Scrum

• 매일 저녁 10시에 스크럼 진행
• 스크럼 내용 : 완료 된 일, 진행 한 일, 남은 일, 이슈사항 공유
• 코드 컨벤션 : 코드 컨벤션 리뷰

Notion

• 일정 관리 : 일정 관리 및 문서화
• 문서화 : 프로젝트 관련 문서화 요구사항 관리, API 명세서, 클래스 다이어그램, ERD 등

이슈 관리

• 이슈 템플릿 : 이슈 템플릿을 사용하여 이슈 작성
• 이슈 담당자 : 이슈 담당자를 지정하여 이슈 관리
• 버그 공유 : 버그 발생 시 이슈를 통해 공유
• 진행 상황 : 현재 진행상황을 이슈를 통해 공유 및 관리

PR 관리

• PR Template : PR 템플릿을 사용하여 PR 작성

커밋 메시지 규칙

커밋 메시지 : 커밋 메시지 규칙을 준수하여 커밋

• feat: 새로운 기능 추가
• fix: 버그 수정
• docs: 문서 수정
• style: 코드 포맷팅, 세미콜론 누락, 코드 변경이 없는 경우
• refactor: 코드 리팩토링
• test: 테스트 코드, 리팩토링 테스트 코드 추가
• chore: 빌드 업무 수정, 패키지 매니저 수정
• comment: 필요한 주석 추가 및 변경
• rename: 파일 혹은 폴더명을 수정하거나 옮기는 작업만인 경우
• remove: 파일을 삭제하는 작업만 수행한 경우

이슈 & PR 템플릿

## 1. 기능 설명

<br>

## 2. 상세 설명

<br>

## 3. 추가 사항

🌸 기타 사항

Swagger API 문서

• URL : Swagger API 문서

ERD

클래스 다이어그램