일반 쓰레기통 및 담배꽁초 쓰레기통 위치 제공 서비스
SCANNER는 사용자에게 일반 쓰레기통 및 담배꽁초 전용 쓰레기통 위치를 제공하여 조금이나마 쓰레기를 올바르게 처리할 수 있도록 유도하였습니다.
수많은 일반 쓰레기통 위치를 확인하고 쓰레기통이 부족하다는 인식을 완화할 수 있으며, 담배꽁초로 발생하는 화재 및 환경 오염 문제를 헤결 하고자 하였습니다.
- 로그인
- CoolSMS API를 활용한 문자 인증 기능을 도입하여 보다 안전한 회원가입을 할 수 있습니다.
- 위치 확인
- 사용자의 위치 200m 전방의 모든 쓰레기통 위치를 지도를 통해 확인할 수 있습니다.
- Elasticsearch를 활용한 검색 기능을 통해 보다 빠르게 쓰레기통 위치를 찾을 수 있습니다.
- 쓰레기통 세부 정보(쓰레기통 상태, 사진 등)를 확인할 수 있습니다.
- 신고 게시글 작성
- 새로운 쓰레기통을 발견하면 쓰레기통 위치 추가 신고 게시글을 작성할 수 있습니다.
- 쓰레기통 상태가 수정되면 쓰레기통 수정 신고 게시글을 작성할 수 있습니다.
- 쓰레기통 제거를 원하시면 쓰레기통 삭제 신고 게시글을 작성할 수 있습니다.
- 신고 게시글이 서비스에 반영되면 포인트를 얻을 수 있습니다.
- 상품 구매
- 사용자는 얻은 포인트를 통해 쓰레기통과 관련된 상품을 구매할 수 있습니다.
- 상품은 바코드로 지급됩니다.
- Java 17
- Python 3
- Spring Boot 3
- Data JPA
- Spring Security
- React
- MySQL
- Redis
- Elasticsearch Document
- Github Actions
- AWS
- Docker
- Promtail + Loki + Grafana
- Prometheus + Grafana
- Github
- Notion
- Slack
☝ .env 파일을 사용하여 application.yml 환경 변수를 관리합니다.
☝ 파일 마지막 줄은 빈칸을 둡니다.
public class A { } // 마지막 줄은 빈칸으로 두기 // git 빨간 줄 안내 없애기 위함
☝ DTO명 규칙
도메인 + 서비스(동사) + request/response + DTO ex) MemberSigninRequestDTO
☝ DTO명 규칙
@PostMapping("") public ApiResponse<OrderResponseDto> createOrder(@RequestBody @Valid CreateOrderRequestDto requestDto) { OrderResponseDto responseDto = orderService.createOrder(requestDto); return ApiResponse.ok(201, responseDto, "상품 주문 성공") } return ApiResponse.ok(200, responseDto, "주문 조회 성공"); //응답 성공 return ApiResponse.ok("주문 취소 성공"); //반환할 데이터 없을 때
☝ Service는 인터페이스를 활용하여 작성합니다.
public interface TrashService { // ... }
☝ 에러코드 규칙
NOT_EXIST_RESOURCE(400, "message"); // 자원을 찾지 못할 때에는 NOT_FOUND가 아닌 NOT_EXIST를 사용
☝ Enum 변수의 이름은 대문자로 작성합니다.
// 상태 - XXX_STATUS public enum MemberStatus { WAITING_STATUS, // 수락 대기 상태 ACCEPT_STATUS, // 수락 상태 WITHDRAW_STATUS // 탈퇴 상태 } // 유형 - XXX_TYPE public enum UserType { ADMIN_TYPE, CUSTOMER_TYPE, GUEST_TYPE; }
☝ builder를 호출하는 static 메서드는 다음 규칙을 따릅니다.
- 파라미터가 1개인 경우: xxxFrom
public static User createUserFromUsername(String username) { // username을 사용해 builder 호출 return new User(username); }
- 파라미터가 2개 이상인 경우: xxxOf
public static User createUserOf(String username, String email) { // username과 email을 사용해 builder 호출 return new User(username, email); }
☝ 다른 객체로 변환하는 메서드의 이름은 toEntity 형식으로 선언합니다.
@Getter public class ProductCreateRequest { private ProductType type; private ProductSellingStatus sellingStatus; private String name; private int price; // AllArgumentConstructor는 private으로 직접 사용을 막아주고, // @Builder 선언해서 직접 사용 막기 @Builder private ProductCreateRequest(ProductType type, ProductSellingStatus sellingStatus, String name, int price) { this.type = type; this.sellingStatus = sellingStatus; this.name = name; this.price = price; } // toEntity public Product toEntity(String productNumber) { return Product.builder() .productNumber(productNumber) .type(type) .sellingStatus(sellingStatus) .name(name) .price(price) .build(); } }
feat: 새로운 기능 추가, 기존의 기능을 요구 사항에 맞추어 수정fix: 기능에 대한 버그 수정build: 빌드 관련 수정chore: 패키지 매니저 수정, 그 외 기타 수정 ex) .gitignorecicd: CI 관련 설정 수정docs: 문서(주석) 수정style: 코드 스타일, 포맷팅에 대한 수정refactor: 기능의 변화가 아닌 코드 리팩터링 ex) 변수 이름 변경test: 테스트 코드 추가/수정release: 버전 릴리즈본문에는 다음을 유의하여 작성합니다.
- 본문 내용은 양에 구애받지 않고 최대한 상세히 작성한다.
- 어떻게보다는 무엇을, 왜 변경했는지를 설명한다.
- 항목이 여러 개일 시 '_'를 통해 구분해서 작성한다.
feat: Add user authentication via Google OAuth - 사용자 인증을 위해 Google OAuth를 추가함 - 기존 로컬 로그인 방식과 함께 사용 가능하도록 병행 지원 - Google OAuth를 선택한 사용자의 프로필 정보(이름, 이메일)를 DB에 저장 - 보안을 강화하기 위해 OAuth 로그인 시 자동으로 HTTPS로 리다이렉트 되도록 설정함
- [BUG]: 버그 리포트
- [FEATURE]: 새로운 기능 요청
- [DOCS]: 문서 관련 작업
- [TEST]: 테스트 관련 작업
- [QUESTION]: 질문 또는 논의
[FEATURE] Add user profile page
본문은 다음의 내용을 포함해야 합니다.
- 만들고자 하는 기능
- 기능을 구현하기 위해 해야 할 일
### 만들고자 하는 기능 ex) Todo 생성 기능 ### 해당 기능을 구현하기 위해 할 일 - [ ] Job1 - [ ] Job2 - [ ] Job3이슈의 가독성을 위해서 라벨을 사용합니다. 두 가지 종류의 라벨이 존재합니다.
- 이슈 타입
- 담당자
- resolved : #issue 번호 추가
- PR 시 2명에게 코드 리뷰 받고 병합
- develop에 PR 병합 시 팀원들에게 공유하기, 각자 진행 중인 브랜치에 리베이스 하기
resolved : #1 ## 📌 과제 설명 <!-- 어떤 걸 만들었는지 대략적으로 설명해주세요 --> 👩💻 요구 사항과 구현 내용 <!-- 기능을 Commit 별로 잘개 쪼개고, Commit 별로 설명해주세요 --> ## ✅ 피드백 반영사항 <!-- 지난 코드리뷰에서 고친 사항을 적어주세요. 재PR 시에만 사용해 주세요! (재PR 아닌 경우 삭제) --> ## ✅ PR 포인트 & 궁금한 점 <!-- 리뷰어 분들이 집중적으로 보셨으면 하는 내용을 적어주세요 -->
- Main Branch: 배포 가능한 상태의 안정적인 코드가 유지되는 브랜치로, 항상 최신의 안정된 버전을 반영합니다.
- Develop Branch: 새로운 기능 개발과 버그 수정을 위한 통합 브랜치로, 개발 중인 코드가 모이는 곳입니다.
- Feature Branch: 특정 기능이나 작업을 위해 독립적으로 개발하는 브랜치로, 완료 후 develop 브랜치에 병합됩니다.
예시) feature/123-add-user-login
- feature/: 새로운 기능 개발
- 123: 이슈 트래커에서 발급된 이슈 번호
- add-user-login: 사용자 로그인 기능 추가
BackEnd 🖥 류정원 |
BackEnd 🖥 윤서진 |
BeckEnd 🖥 이훈일 |
BackEnd 🖥 김지은 |
BackEnd 🖥 김재희 |