diff --git a/README.md b/README.md index 70c0e6a..e6886fc 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,8 @@ ![img_5.png](src/main/resources/static/images/로고.png) -
-

Botanify

-

식물 성장 기록 & 정보 공유 커뮤니티 서비스

-
+

Botanify

+

식물 성장 기록 & 정보 공유 커뮤니티 서비스

### 🌱 목차
@@ -14,9 +12,9 @@ - [서비스 소개](#-서비스-소개) - [기술 스택](#-기술-스택) - [설치 및 실행 방법](#-프로젝트-설치-및-실행법) -- [프로젝트 구조 ](#프로젝트-구조 ) -- [주요 기능](#주요-기능) -- [Developer](#Developer) +- [프로젝트 구조](#-프로젝트-구조) +- [주요기능](#-주요기능) +- [Developer](#-developer) ### 💁‍♀️ 서비스 소개
@@ -26,29 +24,54 @@ - 사용자가 자신의 식물을 관리하고, 성장 상태를 기록하며, 식물 관련 정보를 공유할 수 있도록 돕는 애플리케이션입니다. - 저희의 목표는 식물 성장 일지를 기록하고 정보를 공유하는 커뮤니티 서비스를 제공하여, 사용자들의 식집사 생활을 더 쉽고 재미있게 만드는 것입니다. -

🎥 시연연상

+

🎥 시연영상

+ ### 🔧 기술 스택
-#### Backend -![Java](https://img.shields.io/badge/Java-17-blue) -![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.4.0-brightgreen) -![JPA](https://img.shields.io/badge/JPA-orange) -![MySQL](https://img.shields.io/badge/MySQL-8.0-lightblue) -![RestAPI](https://img.shields.io/badge/RestAPI-red) -![Spring Security](https://img.shields.io/badge/Spring%20Security-green) -![JWT](https://img.shields.io/badge/JWT-blue) - -#### DevOps & Tools -![Jenkins](https://img.shields.io/badge/Jenkins-CI%2FCD-yellow) -![Docker](https://img.shields.io/badge/Docker-Container-blue) -![AWS](https://img.shields.io/badge/AWS-Cloud-orange) -![Redis](https://img.shields.io/badge/Redis-InMemoryDB-red) - -#### Design & Collaboration -![Figma](https://img.shields.io/badge/Figma-Design-orange) -![GitHub](https://img.shields.io/badge/GitHub-VersionControl-black) +#### 💻 Backend + + + + + + + + +#### ⚙️ DevOps & Infrastructure + + + + + + + + +#### 🛠 Development & Database + + + + + +#### 🔍 Testing & Monitoring + + + + +#### 🔌 External Services + + + + + + +#### 🎨 Design & Collaboration + + + + + ### ⚙️ 프로젝트 설치 및 실행법
@@ -261,14 +284,13 @@ $java -jar Botanify-0.0.1-SNAPSHOT.jar ![img_6.png](src/main/resources/static/images/아키텍쳐.png) #### ERD - -![img_7.png](src/main/resources/static/images/ERD.png) +![img_7.jpeg](src/main/resources/static/images/ERD.jpeg) #### API -- [API 문서 바로가기](https://documenter.getpostman.com/view/38557384/2sAYJ99dj3) +- API 문서 바로가기 - 위 링크에서 API 엔드포인트, 요청/응답 예제, 그리고 파라미터에 대한 상세한 설명을 확인하고 Postman에서 직접 테스트할 수 있습니다. +위 링크에서 API 엔드포인트, 요청/응답 예제, 그리고 파라미터에 대한 상세한 설명을 확인하고 Postman에서 직접 테스트할 수 있습니다. ### 🌿 주요기능 @@ -331,13 +353,88 @@ $java -jar Botanify-0.0.1-SNAPSHOT.jar - **게시판 기능**: 사용자 간 정보 공유 및 커뮤니티 활동을 위한 게시판을 제공합니다. ### 👨‍💻 Developer - -
- -| 이름 | 역할 | GitHub | -|-----|---------|--------------------------------------------------| -| 장재혁 | Backend | [GitHub Link](https://github.com/34-43) | -| 김동주 | Backend | [GitHub Link](https://github.com/Despereaux-MAU) | -| 고아라 | Backend | [GitHub Link](https://github.com/arago07) | -| 소성 | Backend | [GitHub Link](https://github.com/gbognon25) | -| 지민지 | Backend | [GitHub Link](https://github.com/JIMINJI1) | \ No newline at end of file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
이름역할담당 업무GitHubBlog link
장재혁팀장 + 📝 Diary Service
+ - 성장 일지 CRUD 기능 구현
+ 📷 Image
+ - S3 활용 이미지 업로드 기능 구현
+ 🌱 식물관리
+ - 식물 OPEN API 데이터 저장 기능 구현
+ - 식물 OPEN API 데이터 캐싱 처리
+ 📝 테스트 코드
+ - 테스트 코드 초안 작성 +
GitHub LinkBlog link
김동주부팀장 + 🧑‍💻 회원가입/로그인
+ - 이메일 회원가입/로그인 기능 구현
+ - Google 소셜 회원가입/로그인 기능 구현
+ - Security 인증/인가
+ 🌦️ 날씨 서비스
+ - 지도 API, 날씨 API 연동 및 날씨 정보 제공 기능 구현
+ 🐳 Docker Compose
+ - Docker Compose 환경 설정
+ 🔄 CI/CD
+ - Jenkins를 활용한 CI/CD 파이프라인 구축 +
GitHub LinkBlog link
고아라팀원 + 🌱 품종 서비스
+ - 품종 CRUD 기능 구현
+ 📝 테스트 코드
+ - 테스트 코드 작성 및 커버리지 체크
+ 🌦️ 날씨 서비스
+ - 위도/경도 좌표 수집 +
GitHub LinkBlog link
리칸소성 (LIKANE SO SOUNG)팀원 + ✉️ User Email Authentication
- 회원가입 시 사용자의 이메일 인증 시스템 구축
+ 👥 Community Service
- 인기 게시글 캐싱 시스템 구축
- 댓글과 답글 기능 구현
- 1:1 실시간 채팅 시스템 구축
+ 🌱 식물 관리
- 식물 push 알림 시스템 구축 +
GitHub LinkBlog link
지민지팀원 + 👥 Community Service
- 게시판 CRUD 기능 구현
+ - 게시글 조회수 어뷰징 방지 로직 설계 및 구현
+ 🌱 식물관리
- 식물 Open API 연동 및 식물 정보 검색 및 조회 기능 구현
+ 🔄 CI/CD
- Jenkins를 활용한 CI 파이프라인 구축
+
GitHub LinkBlog link
diff --git a/src/main/resources/static/images/ERD.jpeg b/src/main/resources/static/images/ERD.jpeg new file mode 100644 index 0000000..fb4c89a Binary files /dev/null and b/src/main/resources/static/images/ERD.jpeg differ diff --git a/src/main/resources/static/images/ERD.png b/src/main/resources/static/images/ERD.png deleted file mode 100644 index da564b6..0000000 Binary files a/src/main/resources/static/images/ERD.png and /dev/null differ