/petandbe-BE

Petandbe

Intro

  • 이 프로젝트는 클라이언트의 needs에 적절한 반려동물 호텔, 유치원의 정보를 제공하는 사이트 제작을 목표로 합니다.

Planning Background

  • 야놀자나 여기어때에는 반려동물과 함께 여행을 갈 수 있는 반려동물 동반 펜션은 있었지만, 반려동물만 맡길 수 있는 호텔이나 유치원 같은 카테고리는 없었다. 반려동물과 함께 생활하는 1인 가구, 혹은 집을 자주 비워야 하는 분들을 위한 서비스를 제공하기 위해 해당 플랫폼을 개발하게 되었다.
  • 또한 해외여행이나 긴 시간 여행을 떠나는 사람에게도 충분히 수요가 있다. 여행을 떠나기 위해선 우리 반려동물이 있어야 하는 장소를 찾아야 하는데, 이러한 문제를 호텔이나 편센을 예약하듯 간편하게 할 수 있도록 하는 플랫폼을 목표로 했다.

Site

Period

2022.11.14 ~

Members

김훈기 김성호 정정일 장형주
Backend Backend Backend DevOps

Architecture

petandbe drawio

Used Tools

Application

Test

Database

Docs

Cloud

Infra

Communication

Git Strategy

  • git flow 전략 사용
  • feature 브랜치 생성 기준은 큰 기능 단위로 → 로그인 / 채팅 / …
    • 생성된 feature 브랜치에서 세부 기능 단위로 새롭게 브랜치 체크아웃 후 해당 브랜치에서 세부 기능 구현
  • issue 또한 기능 단위로 생성 후 PR에 이슈번호 연동
  • 세부 기능 구현 완료 후 개인 로컬 환경에서 테스트 후 feature 브랜치에 PR 머지
  • 세부 기능이 모두 구현 완료되어 큰 기능 구현이 완료된 경우 feature 브랜치에 머지된 커밋들 정리
    • 커밋은 issue 이름과 같도록 하며 기존에 하던 커밋들은 squash를 통해 아래에 명시 or PR에 명시

스크린샷 2022-12-15 12 19 57

Git-flow Example

How to run

1. Reveal secret files

git secret reveal 명령어를 사용하기 위해서는 먼저 GPG 키가 git secret에 추가된 상태여야 합니다.
관련 문서는 노션에 ops/git secret 문서로 정리해두었으니 참고 바랍니다.

git secret reveal

2. Build image

docker-compose -f docker-compose.yml build

3. Run docker-compose

docker-compose -f docker-compose.yml up -d

4. Status Check

# Check nginx health status.
# You will receive 'status ok' text and 200 status when nginx is running.
curl -X GET http://localhost:80/nginx-healthz

# Check app(spring) health status.
# You will receive 'Success' text and 200 status when spring app is running.
curl -X GET http://localhost:80/healthz

Swagger

Wiki