From 3fdb2337303c83979c591c4924838b0b444d3bfb Mon Sep 17 00:00:00 2001
From: minjikim <79203421+Lightieey@users.noreply.github.com>
Date: Sat, 3 Feb 2024 00:14:12 +0900
Subject: [PATCH] Update README.md
---
README.md | 265 +++++++++++++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 263 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 85c5ca43..838a70e1 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,263 @@
-# Wingle-Backend
-누구나, 가볍게, 안전하게 즐기는 숙명여대 국제교류 온라인 플랫폼, Wingle!
+# 프로젝트 Wingle
+
+
+
+
+누구나, 부담없이, 안전하게 즐기는
+대학생 국제교류 플랫폼 WINGLE 윙글
+
+
+| [이정은](https://github.com/LeeJE20) | [김유진](https://github.com/yujin113) | [김민지](https://github.com/Lightieey)| [김경륜](https://github.com/KimRiun) | [이지수](https://github.com/damda0904) | [조용은](https://github.com/gdakate) |
+| :-----------------------------------: | :-----------------------------------: | :----------------------------------: | :----------------------------------: | :----------------------------------: | :------------------------------------: |
+|
|
|
|
|
|
|
+| BE LEAD | BE | BE | BE | BE | BE |
+
+
+로그인 & 회원가입 페이지
+
+👉 로그인페이지: 토큰을 받아오고, 계정 정보를 받아오면 헤더 이미지와 마이페이지, 로그인 시 자신이 저장한 픽 마커 호출되는 기능, 로그아웃하면 초기화
+
+
+
+👉 회원가입 및 업로드 후 어드민 페이지에서 확인 가능
+
+
+
+
+커뮤니티
+
+👉 자유, 교류 공지 게시판
+
+
+
+👉 작성(생성)
+
+
+
+👉 수정
+
+
+
+👉 삭제
+
+
+
+
+쪽지(Chat)
+
+👉 교류게시판의 유저 마이페이지에서 쪽지 보내기
+
+
+
+
+마이페이지 & 프로필 페이지
+
+👉 계정 관련 정보 호출 및 계정 정보 Edit 기능 구현
+
+
+
+👉 쿼리에서 사용자 ID 를 가져와서 사용자 정보 호출
+
+
+
+
+## 🧑🏻💻 개발 관련 기술
+
+
+### 👩🏻🔧 **기술 스택**
+
+#### **Back-end**
+
+
+
+#### **Common**
+
+
+
+### [📺 화면 설계서](https://www.figma.com/file/NCg4EKDErVM7VTvfXDAzmC/UI%EB%94%94%EC%9E%90%EC%9D%B8-(MVP)?type=design&node-id=3578%3A14959&mode=design&t=V3gtJQUdXFC6AK7f-1)
+
+
+
+### 🚧 아키텍쳐
+
+
+
+### 💽 DB 설계
+
+
+
+### 📄 API 명세서
+
+
+### ✔️ 깃 컨벤션
+
+#### 커밋 컨벤션
+
+기본 형식: [소문자] 한국어 설명
+예시: [feat] 로그인
+
+#### 브랜치 전략
+
+feature/fix/etc -> develop -> main
+
+#### 브랜치명 컨벤션
+
+기본 형식: 태그/이슈이름-그대로-#이슈번호
+예시: feat/create-group-#14
+
+### 🗂️ 폴더 구조
+```bash
+.
+├── WingleApplication.java
+├── affliation
+│ ├── controller
+│ ├── dto
+│ ├── entity
+│ ├── repository
+│ └── service
+├── common
+│ ├── aop
+│ │ ├── LogAspect.java
+│ │ ├── LogConfig.java
+│ │ ├── LogTraceIdInterceptor.java
+│ │ └── NoLogging.java
+│ ├── config
+│ │ ├── AmazonS3Config.java
+│ │ ├── JwtSecurityConfig.java
+│ │ ├── MailConfig.java
+│ │ ├── RedisConfig.java
+│ │ ├── RestTemplateConfig.java
+│ │ ├── SecurityConfig.java
+│ │ └── WebMvcConfig.java
+│ ├── constants
+│ │ ├── ErrorCode.java
+│ │ └── SuccessCode.java
+│ ├── dto
+│ │ └── ApiResponse.java
+│ ├── entity
+│ │ └── BaseEntity.java
+│ ├── exception
+│ │ ├── BadRequestException.java
+│ │ ├── DuplicateException.java
+│ │ ├── ForbiddenException.java
+│ │ ├── InternalServerErrorException.java
+│ │ ├── NotFoundException.java
+│ │ ├── NumberFormatException.java
+│ │ ├── RestExceptionHandler.java
+│ │ └── UnauthorizedException.java
+│ ├── filter
+│ │ ├── ApiLoggingFilter.java
+│ │ ├── ReadableRequestBodyWrapper.java
+│ │ └── ReadableResponseBodyWrapper.java
+│ ├── jwt
+│ │ ├── JwtAccessDeniedHandler.java
+│ │ ├── JwtAuthenticationEntryPoint.java
+│ │ ├── JwtFilter.java
+│ │ ├── TokenInfo.java
+│ │ └── TokenProvider.java
+│ ├── util
+│ │ ├── AES256Util.java
+│ │ ├── RedisUtil.java
+│ │ ├── S3Util.java
+│ │ ├── SecurityUtil.java
+│ │ └── StringUtil.java
+│ └── validator
+│ ├── LengthWithoutCR.java
+│ └── LengthWithoutCRValidator.java
+├── community
+│ ├── article
+│ │ ├── Article.java
+│ │ ├── ArticleController.java
+│ │ ├── ArticleEditRequestDto.java
+│ │ ├── ArticleImage.java
+│ │ ├── ArticleImageRepository.java
+│ │ ├── ArticleMapper.java
+│ │ ├── ArticleRepository.java
+│ │ ├── ArticleRequestDto.java
+│ │ ├── ArticleResponseDto.java
+│ │ └── ArticleService.java
+│ ├── comment
+│ │ ├── Comment.java
+│ │ ├── CommentController.java
+│ │ ├── CommentMapper.java
+│ │ ├── CommentRepository.java
+│ │ ├── CommentRequestDto.java
+│ │ ├── CommentResponseDto.java
+│ │ └── CommentService.java
+│ ├── forum
+│ │ ├── Forum.java
+│ │ ├── ForumCode.java
+│ │ ├── ForumController.java
+│ │ ├── ForumMapper.java
+│ │ ├── ForumRepository.java
+│ │ ├── ForumResponseDto.java
+│ │ └── ForumService.java
+│ └── util
+│ ├── CommunityUtil.java
+│ └── ProcessedPersonalInformation.java
+├── member
+│ ├── AuthController.java
+│ ├── MemberController.java
+│ ├── MemberRepository.java
+│ ├── TermMemberRepository.java
+│ ├── TermRepository.java
+│ ├── dto
+│ ├── entity
+│ ├── mailVo
+│ └── service
+├── message
+│ ├── OriginType.java
+│ ├── controller
+│ ├── dto
+│ ├── entity
+│ ├── mapper
+│ ├── repository
+│ └── service
+├── profile
+│ ├── InterestRepository.java
+│ ├── LanguageRepository.java
+│ ├── MemberInterestRepository.java
+│ ├── ProfileController.java
+│ ├── ProfileRepository.java
+│ ├── ProfileService.java
+│ ├── SnsRepository.java
+│ ├── dto
+│ ├── entity
+│ └── util
+└── writing
+ ├── Writing.java
+ ├── WritingDto.java
+ ├── WritingRepository.java
+ ├── WritingService.java
+ └── WritingUtil.java
+```
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+