Skip to content

Commit

Permalink
docs: read.me전체 수정
Browse files Browse the repository at this point in the history
  • Loading branch information
@Suxxxxhyun
Suxxxxhyun committed Jan 31, 2024
1 parent 17bad17 commit bb9dece
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 84 deletions.
144 changes: 60 additions & 84 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# petree-backend
## ⭐ 프로젝트 소개
⭐ 프로젝트 소개
---
<img src="./petree-img/home.png" >

Expand All @@ -14,88 +14,64 @@
-
**Breeder와 Adopter(분양희망자)를 연결하여, 강아지를 분양받도록 도와주는 프로젝트**

### ⏰개발 기간
## ⏰개발 기간

- 2023.04.17 ~ 2023.11.05

### 📎배포 사이트
## 📎배포 사이트

- 펫트리
- [펫트리](https://nextpetree.store/)

## 👤 팀원 소개
👤 팀원 소개
---
<table>
<tbody>
<tr>
<td align="center"><a href="https://github.com/Suxxxxhyun"><img src="./petree-img/박수현.jpg" width="150" height="150"/><br /><sub><b>BE 팀장 : 박수현</b></sub></a><br /></td>
<td align="center"><a href="https://github.com/granen32"><img src="./petree-img/권규형.jpg" width="150" height="150" alt=""/><br /><sub><b>FE 부팀장 : 권규형</b></sub></a><br /></td>
<td align="center"><a href="https://github.com/ChanghyeonO"><img src="./petree-img/오창현.png" width="150" height="150" alt=""/><br /><sub><b>FE 팀원 : 오창현</b></sub></a><br /></td>
<td align="center"><a href="https://github.com/kjungit"><img src="./petree-img/권범준.jpg" width="150" height="150" alt=""/><br /><sub><b>FE 팀원 : 권범준</b></sub></a><br /></td>
<td align="center"><a href=""><img src="./petree-img/이지수.png" width="150" height="150" alt=""/><br /><sub><b>BE 팀원 : 이지수</b></sub></a><br /></td>
<td align="center"><a href=""><img src="./petree-img/이수언.png" width="150" height="150" alt=""/><br /><sub><b>디자이너 : 이수언</b></sub></a><br /></td>
</tr>
<tr>
<td>
<ol>
<li>데이터베이스 설계</li>
<li>docker, CICD를 통한 ec2배포</li>
<li>브리더 모아보기 거리순 정렬</li>
<li>JWT로그인</li>
<li>카카오Oauth</li>
<li>강아지모아보기 다중검색</li>
<li>견종검색</li>
<li>기초지식테스트</li>
<li>제3자가 보는 브리더프로필조회</li>
<li>제3자가 보는 분양희망자프로필조회</li>
<li>분양후기관리</li>
<li>분양신청내역</li>
<li>회원정보수정</li>
<li>프로필관리</li>
<li>회원가입</li>
<li>회원탈퇴</li>
</ol>
</td>
<td>
<ol>
<li>보유견종관리</li>
<li>분양후기</li>
</ol>
</td>
<td>
<ol>
<li>땡땡</li>
</ol>
</td>
<td>
<ol>
<li>땡땡</li>
</ol>
</td>
<td>
<ol>
<li>브리더 인증받기</li>
<li>관리자 승인</li>
<li>보유견종관리</li>
</ol>
</td>
<td>
<ol>
<li>피그마를 통한 디자인</li>
<li>시연영상</li>
</ol>
</td>
</tr>
</tbody>
</table>

## 💠 아키텍쳐

**박수현(팀장)**
- 데이터베이스 설계
- nginx, docker, CICD를 통한 ec2배포
- 아키텍처 설계브리더 모아보기 거리순 정렬 및 페이징처리
- jwt자체 로그인 / 로그아웃
- 카카오 Oauth로그인
- 강아지 다중 검색
- 반려인 지식테스트 랜덤 조회, 점수 반환 및 틀린 문항에 대한 해설 반환
- 강아지 예약신청 및 결재
- 제3자가 보는 브리더, 분양희망자 프로필 조회
- 분양후기CRUD
- 분양신청내역 페이징 처리
- 회원 정보 수정

**오창현(프론트 부팀장)**
- 로그인
- 회원가입
- 회원탈퇴
- 분양신청내역

**김민준(프론트)**
- 강아지 모아보기
- 브리더 모아보기
- 프로필 관리
- 회원정보 수정

**김용현(프론트)**
- 강아지 모아보기 상세
- 브리더 모아보기 상세
- 분양후기 관리

**이지수(백엔드)**
- 보유견종 CRUD
- 브리더 관련 자격증 제출 및 결재

**이수언(디자이너)**
- 피그마를 통한 디자인
- 시연영상 제작

💠 아키텍쳐
---
<img src="./petree-img/아키텍쳐.png" >
<img src="../petree-img/최종 아키텍쳐(0115).png">

## 🖥️프로젝트 미리보기
🖥️프로젝트 미리보기
---

## 🏷️ Backend 폴더 구조
🏷️ Backend 폴더 구조
---
<pre>
<code>
Expand All @@ -106,7 +82,7 @@
├─ gradle
│ └─ wrapper
│ │ ├─ gradle-wrapper.jar
│ │ ├─ gradle-wrapper.properties
│ │ └─ gradle-wrapper.properties
├─ src
│ ├─ main
│ │ ├─ java
Expand All @@ -121,62 +97,62 @@
│ │ │ │ │ │ │ │ │ ├─ dto
│ │ │ │ │ │ │ │ │ ├─ repository
│ │ │ │ │ │ │ │ │ ├─ schema
│ │ │ │ │ │ │ │ │ ├─ service
│ │ │ │ │ │ │ │ │ └─ service
│ │ │ │ │ │ │ │ ├─ basic_test
│ │ │ │ │ │ │ │ │ ├─ controller
│ │ │ │ │ │ │ │ │ ├─ domain
│ │ │ │ │ │ │ │ │ ├─ dto
│ │ │ │ │ │ │ │ │ ├─ repository
│ │ │ │ │ │ │ │ │ ├─ schema
│ │ │ │ │ │ │ │ │ ├─ service
│ │ │ │ │ │ │ │ │ └─ service
│ │ │ │ │ │ │ │ ├─ breeder
│ │ │ │ │ │ │ │ │ ├─ controller
│ │ │ │ │ │ │ │ │ ├─ domain
│ │ │ │ │ │ │ │ │ ├─ dto
│ │ │ │ │ │ │ │ │ ├─ repository
│ │ │ │ │ │ │ │ │ ├─ schema
│ │ │ │ │ │ │ │ │ ├─ service
│ │ │ │ │ │ │ │ │ └─ service
│ │ │ │ │ │ │ │ ├─ dog
│ │ │ │ │ │ │ │ │ ├─ controller
│ │ │ │ │ │ │ │ │ ├─ domain
│ │ │ │ │ │ │ │ │ ├─ dto
│ │ │ │ │ │ │ │ │ ├─ repository
│ │ │ │ │ │ │ │ │ ├─ schema
│ │ │ │ │ │ │ │ │ ├─ service
│ │ │ │ │ │ │ │ │ └─ service
│ │ │ │ │ │ │ │ ├─ main_breed
│ │ │ │ │ │ │ │ │ ├─ controller
│ │ │ │ │ │ │ │ │ ├─ domain
│ │ │ │ │ │ │ │ │ ├─ dto
│ │ │ │ │ │ │ │ │ ├─ repository
│ │ │ │ │ │ │ │ │ ├─ schema
│ │ │ │ │ │ │ │ │ ├─ service
│ │ │ │ │ │ │ │ │ └─ service
│ │ │ │ │ │ │ │ ├─ matching
│ │ │ │ │ │ │ │ │ ├─ controller
│ │ │ │ │ │ │ │ │ ├─ domain
│ │ │ │ │ │ │ │ │ ├─ dto
│ │ │ │ │ │ │ │ │ ├─ repository
│ │ │ │ │ │ │ │ │ ├─ schema
│ │ │ │ │ │ │ │ │ ├─ service
│ │ │ │ │ │ │ │ │ └─ service
│ │ │ │ │ │ │ │ ├─ member
│ │ │ │ │ │ │ │ │ ├─ controller
│ │ │ │ │ │ │ │ │ ├─ domain
│ │ │ │ │ │ │ │ │ ├─ dto
│ │ │ │ │ │ │ │ │ ├─ repository
│ │ │ │ │ │ │ │ │ ├─ schema
│ │ │ │ │ │ │ │ │ ├─ service
│ │ │ │ │ │ │ │ │ └─ service
│ │ │ │ │ │ │ │ ├─ verification
│ │ │ │ │ │ │ │ │ ├─ controller
│ │ │ │ │ │ │ │ │ ├─ domain
│ │ │ │ │ │ │ │ │ ├─ dto
│ │ │ │ │ │ │ │ │ ├─ repository
│ │ │ │ │ │ │ │ │ ├─ schema
│ │ │ │ │ │ │ │ │ ├─ service
│ │ │ │ │ │ │ │ │ └─ service
│ │ │ │ │ │ │ ├─ global
│ │ │ │ │ │ │ │ ├─ config
│ │ │ │ │ │ │ │ ├─ error
│ │ │ │ │ │ │ │ ├─ jwt
│ │ │ │ │ │ │ │ ├─ util
│ │ │ │ │ │ │ │ └─ web
│ │ │ │ │ │ │ └─ └─ web
│ │ │ └─ resources
│ │ │ └─ querydsl
│ │ │ └─ test
Expand All @@ -188,7 +164,7 @@
│ ├─ gradlew
│ ├─ gradlew.bat
│ ├─ README.md
│ └─ settings.gradle
└─ └─ settings.gradle
</code>
</pre>

Binary file removed petree-img/아키텍쳐.png
View file
Binary file not shown.
Binary file added petree-img/최종 아키텍쳐(0115).png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bb9dece

Please sign in to comment.