diff --git a/README.md b/README.md index 283b096..7814902 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,102 @@ -# spring-feeda -모두가 모여 서로의 스터디 정보와 노하우를 나누는 커뮤니티 SNS입니다. +# 피다(Feeda) +개발자, 학생, 그리고 자기 계발에 관심 있는 모두가 모여 서로의 스터디 정보와 노하우를 나누는 커뮤니티 SNS입니다. + +- 스터디 모집 및 경험 공유 +- 질문과 답변을 통한 지식 나눔 +- 성장과 동기부여를 위한 소통 공간 +- 함께 배우고, 함께 성장하는 즐거움을 경험 시켜 드릴수가 있을 것 같습니다. + +
+ +## 👨‍💻 Team +- 팀명: 6pring (식스프링) +- 소개: 4명의 아기자기한 팀 +- 팀원 및 역할 분담 + +| 이름 | 역할 | 주요 담당 업무 | +|-----|----|------------------------------------------------------------------------------------------| +| 최경진 | 팀장 | - 발표 ✨
- 프로필 관련 API 개발
- 게시글 댓글 관련 API 개발 | +| 김나경 | 팀원 | - ERD 작성 및 DB 설계
- JWT 인증/인가 관련 기능 구현
- 회원 관리 관련 API 개발
- 게시글 댓글 좋아요 관련 API 개발 | +| 안요한 | 팀원 | - 와이어 프레임 작성
- 게시글 관련 API 개발
- 게시글 좋아요 관련 API 개발 | +| 이의현 | 팀원 | - API 명세서 작성
- 팔로우(친구 관리) 관련 API 개발
- 전역 예외 처리 핸들러 개발
- 테스트 코드 작성 | + + +
+ +## 🛠 사용 기술 +- Java 17 +- Gradle 8.5 +- Spring Boot 3.5.0 +- Spring Data JPA (Hibernate 6.6.13.Final) +- Spring Security +- MySQL 8.0 이상 +- Redis Cloud + +
+ +## 💻 개발 도구 +- IntelliJ IDEA +- Redis Insight +- Git +- Postman + +
+ +## 📃 프로젝트 설계 +
+API 명세서 + +Postman: [document](https://documenter.getpostman.com/view/44635744/2sB2qgeyJ7) + +Notion +- [필수기능 명세서](https://www.notion.so/2002dc3ef5148050b741cdfba818f530?pvs=21) +- [도전기능 명세서](https://www.notion.so/2022dc3ef51481939541e86c62aa7864?pvs=21) +
+ +
+와이어 프레임 + +![와이어프레임](./images/wireframe.png) +
+ +
+DB 설계 + +- 개념적 설계: + - ![er](./images/er.png) +- 논리적 설계(ERD): + - ![erd](./images/erd.png) +- 물리적 설계(SQL): + - [newsFeed2.sql](./newsFeed2.sql) + - ![erdE](./images/erdE.png) +
+ +
+ +## 📁 폴더 구조 +```bash +src +├──── main.java.com.example.feeda +│ ├──── config # 설정 관련 +│ ├──── domain # 도메인별 기능 분류 +│ │ ├──── account +│ │ ├──── comment +│ │ ├──── follow +│ │ ├──── post +│ │ └──── profile +│ ├──── exception # 예외 클래스 및 처리 +│ ├──── filter # 인증 필터 +│ ├──── security # 보안 관련 (PasswordEncoder, JWT) +│ └──── FeedaApplication.java +└──── test # 테스트 코드 +``` + +
+ +## 🔍 새로운 지식 + + +## 🧰 문제 해결 (트러블 슈팅) + + + diff --git a/images/er.png b/images/er.png new file mode 100644 index 0000000..816fc2b Binary files /dev/null and b/images/er.png differ diff --git a/images/erd.png b/images/erd.png new file mode 100644 index 0000000..cf35035 Binary files /dev/null and b/images/erd.png differ diff --git a/images/erdE.png b/images/erdE.png new file mode 100644 index 0000000..d2c6fb4 Binary files /dev/null and b/images/erdE.png differ diff --git a/images/wireframe.png b/images/wireframe.png new file mode 100644 index 0000000..c8ec456 Binary files /dev/null and b/images/wireframe.png differ