2023. 6. 13.

README.md

@@ -1,20 +1,137 @@
 # Calenkit
-## Team Member
-- 김민재
-- 라재희
-- 이진규
-- 오세욱
 
 ## Project Summary
 - 일정을 등록하고 다른 사람들과 공유할 수 있는 실시간 일정 공유 웹프로그램
 
-### Skill
-- Spring Boot
-- MyBatis
-- MySql
-- JSP
+## 👨‍👨‍👧‍👦Team Member
+- 김민재 : 일정 캘린더 출력, 일정 추가 삭제 및 수정, 휴지통, 즐겨찾기, 검색, 무한 스크롤 기능
+- 라재희 : 일정 메인 및 상세 레이아웃, 일정 초대 및 공유, 일정 내용 변경 실시간 반영, 푸시 알림
+- 이진규 : 회원 개인정보 관리(마이페이지), 회원 관리(관리자페이지), 이미지 전송 기능
+- 오세욱 : 카카오 소셜로그인, 회원가입, 이메일 전송 기능
 
-## Git Policy
+## 📙WIKI
+- calenkit의 부가적 설명은 WIKI를 이용했습니다.
+- [calenkit WIKI](https://github.com/effourt/calenkit/wiki) 내용을 참고해주세요.
+
+## 🛠️Skill
+<p>
+  <img alt="html5" src="https://img.shields.io/badge/-HTML5-E34F26?style=flat-square&logo=html5&logoColor=white" />
+  <img alt="css3" src="https://img.shields.io/badge/css3-1572B6?style=flat&logo=css3&logoColor=white"/>
+  <img alt="bootstrap" src="https://img.shields.io/badge/-bootstrap-7952B3?style=flat-square&logo=bootstrap&logoColor=white" />
+  <img alt="javascript" src="https://img.shields.io/badge/Javascript-F7DF1E?style=flat&logo=javascript&logoColor=white"/>
+  <img alt="jQuery" src="https://img.shields.io/badge/jQuery-0769AD?style=flat&logo=jQuery&logoColor=white"/>
+  <img alt="thymeleaf" src="https://img.shields.io/badge/thymeleaf-005F0F?style=flat&logo=thymeleaf&logoColor=white"/>
+</p>
+<p> 
+  <img alt="java" src="https://img.shields.io/badge/-java-3A75AF?style=flat-square&logo=java&logoColor=white" />
+  <img alt="spring" src="https://img.shields.io/badge/-spring-6DB33F?style=flat-square&logo=spring&logoColor=white" />
+  <img alt="springboot" src="https://img.shields.io/badge/-springboot-6DB33F?style=flat-square&logo=springboot&logoColor=white" />
+  <img alt="springsecurity" src="https://img.shields.io/badge/-springsecurity-6DB33F?style=flat-square&logo=springsecurity&logoColor=white" />
+  <img alt="springcloud" src="https://img.shields.io/badge/-springcloud-6DB33F?style=flat-square&logo=springcloud&logoColor=white" />
+  <img alt="gradle" src="https://img.shields.io/badge/-gradle-02303A?style=flat-square&logo=gradle&logoColor=white" />
+</p>
+<p>
+  <img alt="mysql" src="https://img.shields.io/badge/-mysql-4479A1?style=flat-square&logo=mysql&logoColor=white" />
+  <img alt="mybatis3" src="https://img.shields.io/badge/-mybatis3-211A1A?style=flat-square&logo=mybatis3&logoColor=white" />
+</p>
+<p>
+  <img alt="apacheTomcat" src="https://img.shields.io/badge/-apacheTomcat-F8DC75?style=flat-square&logo=apacheTomcat&logoColor=white" />
+  <img alt="github" src="https://img.shields.io/badge/-github-181717?style=flat-square&logo=github&logoColor=white" />
+</p>
+
+## 🛠️Team Collaboration Tool
+- Github
+- Notion
+- Google Slide
+- diagrams.net
+- ERD Coud
+- Discord
+- Code with Me (IntelliJ)
+
+## ✔Git Branch Policy
+![image](https://github.com/effourt/calenkit/assets/107570140/7b22ea6d-92df-4ee8-9b50-ebb5738cf13a)
+- **Github-Flow** 전략과 유사함
+- 작업은 user-branch에서만 이루어지며 develop, main 브랜치로 직접 접근 불가능
+- 새로운 브랜치는 develop을 기준으로 생성하여 작업 진행
+- 브랜치는 로컬에 commit하고 정기적으로 user-branch로 push
+- 정해진 회의시간에 코드리뷰를 진행하고 pull-request를 생성해 develop 브랜치로 병합
+- 병합은 rebase-merge로, 충돌이 있을 경우 merge로 진행
+- develop 브랜치에 병합 후 user-branch로 pull 받아 기능 테스트
+
+## ✔Git Commit Message Rule
+- [**FEAT]** 문서 내 기능 추가, 변경, 수정이 발생한 경우
+- [**DESIGN]** 문서 내 코드 수정(CSS) 발생한 경우 (기능 영향 있음)
+- [**FIX]** 문서 내 코드 버그 수정 발생한 경우
+- [**DOCS]** 문서의 추가, 삭제, 변경
+- [**STYLE**] 코드 가독성을 위한 수정(주석, 들여쓰기 등) 발생한 경우 (기능 영향 없음)
+- [**REFACTOR]** 효율 증가를 위한 수정 (기능 영향 없음)
+- [**TEST]** 테스트 코드 추가 삭제 변경 - 테스트 코드 관련 모든 변경사항들
+- [**ETC]** 기타 애매한 경우
+
+## ✔ERD Diagram
+![calenkit ERD](https://github.com/effourt/calenkit/assets/107570140/a2914f34-ab48-41f9-91d4-5c1ce705121c)
+## ✔DB Diagram
+![calenkit](https://github.com/effourt/calenkit/assets/107570140/d1ac1e72-9562-407a-aaf3-cfd441b4ff00)
+## 🗓️구현
+
+### ✅ 로그인
+![image](https://github.com/effourt/calenkit/assets/107570140/730a6def-88b8-479b-8975-66f8dbbe75d0)
+- 카카오 소셜 로그인
+![image](https://github.com/effourt/calenkit/assets/107570140/3fba3d1e-3bea-4f09-b474-011fd749614e)
+- 회원 정보가 존재하고 비밀번호가 존재할 경우, 비밀번호로 로그인
+![image](https://github.com/effourt/calenkit/assets/107570140/ecaf251a-888e-4d01-a76b-8b3de6cb0e9c)
+- 회원 정보가 존재하고 비밀번호가 존재하지 않을 경우, 로그인 코드로 로그인
+    - 로그인 코드는 입력한 이메일로 전송
+![image](https://github.com/effourt/calenkit/assets/107570140/13a3e22d-f3df-4c36-bede-3d56b1876c12)
+- 회원 정보가 존재하지 않을 경우, 회원가입 코드로 로그인
+    - 회원가입 코드는 입력한 이메일로 전송
+![image](https://github.com/effourt/calenkit/assets/107570140/6909ec90-cf6b-41ac-bd08-1d38261831c7)
+![image](https://github.com/effourt/calenkit/assets/107570140/7bc2e19f-7177-42a1-a1c3-b721cfa4a1e5)
+### ✅ 회원가입
+- 프로필 사진, 닉네임, 비밀번호 설정 가능
+![image](https://github.com/effourt/calenkit/assets/107570140/e4de6081-5200-4f98-9786-e7f911e34225)
+### ✅ 메인페이지 (🚨로그인 회원만 접속 가능)
+![image](https://github.com/effourt/calenkit/assets/107570140/e5dc31b4-9cf2-4e6e-8078-03e7ff70c5a6)
+- 검색 기능 - 일정 검색(필터링 - 제목, 내용)
+![image](https://github.com/effourt/calenkit/assets/107570140/94cfd757-6b68-4451-b84a-9f4fd6a5d6e4)
+![image](https://github.com/effourt/calenkit/assets/107570140/02756530-b4b3-490f-b71f-219352cfa42f)
+- 검색 기능 - 휴지통 검색
+![image](https://github.com/effourt/calenkit/assets/107570140/3a5ce77d-49d5-49bb-8206-be8b83e2ee71)
+
+
+### ✅ 마이페이지 (🚨로그인 회원만 접속 가능)
+![image](https://github.com/effourt/calenkit/assets/107570140/69d3e6e1-4551-477c-bd2d-f20107029498)
+- 비밀번호 변경
+![image](https://github.com/effourt/calenkit/assets/107570140/cc9c3e32-202f-4a7b-b4e4-563bda38b19b)
+### ✅ 일정 상세페이지 (🚨로그인 회원만 접속 가능)
+- 휴지통 이동 / 메인가기 / 일정 공유 / 즐겨찾기
+![image](https://github.com/effourt/calenkit/assets/107570140/57f7fa98-3c39-404f-8df7-2775d821dc80)
+- 제목, 시작 날짜 및 종료 날짜 변경
+![image](https://github.com/effourt/calenkit/assets/107570140/edfe445d-dcd7-4af5-ace8-7a12007f9430)
+- 진행 상태 변경
+![image](https://github.com/effourt/calenkit/assets/107570140/a903967e-4970-41aa-8da3-f828dab53b15)
+- 내용 작성 및 변경 (실시간 공유)
+![image](https://github.com/effourt/calenkit/assets/107570140/51eb67b6-849f-48fe-b774-b1616f4f2044)
+- 일정 초대 (메일 발송 및 푸시 알림)
+![image](https://github.com/effourt/calenkit/assets/107570140/45e3652c-fd46-4720-918f-80f62d5caed2)
+![image](https://github.com/effourt/calenkit/assets/107570140/a950d7c2-6cd6-45aa-afda-090b67ba59c6)
+![image](https://github.com/effourt/calenkit/assets/107570140/a58a9a4a-b5ce-4204-b7fb-4a1c272b5a16)
+- 일정 참가
+![image](https://github.com/effourt/calenkit/assets/107570140/9535d6dc-8516-4b5c-9830-b4ca749b50fd)
+![image](https://github.com/effourt/calenkit/assets/107570140/3754fcfd-6a18-4c55-969a-1b7854cf0efb)
+![image](https://github.com/effourt/calenkit/assets/107570140/6bd78552-affc-44be-b94c-b38881a1f2b5)
+- 권한 변경(푸시 알림)
+![image](https://github.com/effourt/calenkit/assets/107570140/ab9c8a84-13c1-4f29-9c82-d6ac97a94a0e)
+
+### ✅ 관리자페이지 (🚨관리자만 접속 가능)
+- 회원 상태 변경
+    - 탈퇴회원, 일반회원, 휴면회원, 관리자로 회원 상태 변경 가능
+![image](https://github.com/effourt/calenkit/assets/107570140/ce8345fc-f5b2-4d0a-9876-e76b6c11b23d)
+- 회원 검색
+    - ID의 앞자리가 일치하는 회원 검색
+![image](https://github.com/effourt/calenkit/assets/107570140/717e1dca-747b-4a55-801f-b7beb9d7491e)
+- 회원 정보 삭제
+    - [선택 회원 삭제] 버튼 클릭 시 DB에서 회원 정보 완전 삭제
+![image](https://github.com/effourt/calenkit/assets/107570140/6f0f32e5-ee54-4bef-ac17-d72100e1cae9)
 
-## Naming Rule
 

build.gradle

@@ -18,12 +18,49 @@ repositories {
 	mavenCentral()
 }
 
+ext {
+	//Spring Cloud 버전
+	set('springCloudVersion', "2021.0.1")
+}
+
 dependencies {
 	implementation 'org.springframework.boot:spring-boot-starter-web'
 	implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:2.3.0'
+	implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
+	implementation 'org.springframework.boot:spring-boot-starter-validation'
+
+	//메일 라이브러리
+	implementation 'org.springframework.boot:spring-boot-starter-mail'
+	// Spring Security Crypto 라이브러리 추가
+	implementation 'org.springframework.security:spring-security-crypto:5.5.1' // 최신 버전으로 업데이트 가능
+	//OAuth2.0 라이브러리
+	implementation 'org.springframework.boot:spring-boot-starter-oauth2-client'
+	//Feign 라이브러리
+	implementation "org.springframework.cloud:spring-cloud-starter-openfeign"
+
+	//websocket 사용을 위한 라이브러리 - 참고 : https://spring.io/guides/gs/messaging-stomp-websocket/
+	implementation 'org.springframework.boot:spring-boot-starter-websocket'
+	implementation 'org.webjars:webjars-locator-core'
+	implementation 'org.webjars:sockjs-client:1.0.2'
+	implementation 'org.webjars:stomp-websocket:2.3.3'
+	implementation 'org.webjars:bootstrap:3.3.7'
+	implementation 'org.webjars:jquery:3.1.1-1'
+
+	runtimeOnly 'mysql:mysql-connector-java:8.0.28'
+
+	testImplementation 'org.projectlombok:lombok:1.18.22'
 	compileOnly 'org.projectlombok:lombok'
 	annotationProcessor 'org.projectlombok:lombok'
+
 	testImplementation 'org.springframework.boot:spring-boot-starter-test'
+	testCompileOnly 'org.projectlombok:lombok'
+	testAnnotationProcessor 'org.projectlombok:lombok'
+}
+
+dependencyManagement {
+	imports {
+		mavenBom "org.springframework.cloud:spring-cloud-dependencies:${springCloudVersion}"
+	}
 }
 
 tasks.named('test') {

sql/ddl.sql

@@ -0,0 +1,19 @@
+-- Git Commit Message Rule
+---[FEAT] 문서 내 기능 추가, 변경, 수정이 발생한 경우
+-- [DESIGN]  문서 내 코드 수정(CSS) 발생한 경우 (수정으로 인한 동작 영향 있음)
+-- [FIX] 문서 내 코드 버그 수정 발생한 경우
+-- [DOCS] 문서의 추가,삭제,변경
+-- [STYLE] 문서 내 코드 가독성을 위한 수정(주석, 행간, 들여쓰기 등) 발생한 경우 (수정으로 인한 동작 영향 없음)
+-- [REFACTOR] 효율 증가를 위한 수정 (수정으로 인한 동작 영향 없음)
+-- [TEST] 테스트 코드 추가 삭제 변경 - 테스트 코드 관련 모든 변경사항들
+-- [ETC] 기타 애매한 경우
+
+
+-- DOMAIN	REPOSITORY(mybatis3, JPA)	SERVICE
+--     INSERT	SAVE	ADD
+--     UPDATE	UPDATE	MODIFY
+--     DELETE	DELETE	REMOVE
+--     SELECT	FIND	GET
+
+
+

src/main/java/com/effourt/calenkit/CalenkitApplication.java

@@ -2,8 +2,10 @@
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.cloud.openfeign.EnableFeignClients;
 
 @SpringBootApplication
+@EnableFeignClients(basePackages = {"com.effourt.calenkit.client"})
 public class CalenkitApplication {
 
 	public static void main(String[] args) {

src/main/java/com/effourt/calenkit/client/KakaoApiClient.java

@@ -0,0 +1,24 @@
+package com.effourt.calenkit.client;
+
+import com.effourt.calenkit.dto.AuthUserInfoResponse;
+import org.springframework.cloud.openfeign.FeignClient;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestHeader;
+import org.springframework.web.bind.annotation.RequestParam;
+
+@FeignClient(name = "kakaoApi", url = "https://kapi.kakao.com")
+public interface KakaoApiClient {
+
+    @PostMapping(value = "/v2/user/me", produces = MediaType.APPLICATION_JSON_VALUE)
+    String getAuthUserInfo(
+            @RequestHeader("Authorization") String accessToken,
+            @RequestParam("property_keys") String propertyKeys
+    );
+
+    @PostMapping("/v1/user/logout")
+    String logout(
+            @RequestHeader("Authorization") String accessToken
+    );
+}

src/main/java/com/effourt/calenkit/client/KakaoFeignClient.java

@@ -0,0 +1,27 @@
+package com.effourt.calenkit.client;
+
+import com.effourt.calenkit.config.FeignConfig;
+import com.effourt.calenkit.dto.AccessTokenResponse;
+import com.effourt.calenkit.dto.AuthUserInfoResponse;
+import feign.Headers;
+import org.springframework.cloud.openfeign.FeignClient;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestHeader;
+import org.springframework.web.bind.annotation.RequestParam;
+
+import java.util.Map;
+
+@FeignClient(name = "kakaoAuth", url = "https://kauth.kakao.com", configuration = {FeignConfig.class})
+public interface KakaoFeignClient {
+
+    @PostMapping("/oauth/token")
+    AccessTokenResponse getAccessToken(
+            @RequestParam("client_id") String clientId,
+            @RequestParam("grant_type") String grantType,
+            @RequestParam("redirect_uri") String redirectUri,
+            @RequestParam("code") String authorizationCode
+    );
+}

src/main/java/com/effourt/calenkit/config/FeignConfig.java

@@ -0,0 +1,16 @@
+package com.effourt.calenkit.config;
+
+import com.effourt.calenkit.dto.AuthUserInfoResponse;
+import feign.Logger;
+import org.springframework.boot.autoconfigure.http.HttpMessageConverters;
+import org.springframework.context.annotation.Bean;
+import org.springframework.http.converter.HttpMessageConverter;
+import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
+
+public class FeignConfig {
+
+    @Bean
+    Logger.Level githubFeignClientLoggerLevel() {
+        return Logger.Level.HEADERS;
+    }
+}

src/main/java/com/effourt/calenkit/config/InterceptorConfig.java

@@ -0,0 +1,39 @@
+package com.effourt.calenkit.config;
+
+import com.effourt.calenkit.util.interceptor.AdminAuthInterceptor;
+import com.effourt.calenkit.util.interceptor.LoginInterceptor;
+import com.effourt.calenkit.util.interceptor.UserAuthInterceptor;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+@Slf4j
+@Configuration
+@RequiredArgsConstructor
+public class InterceptorConfig implements WebMvcConfigurer {
+
+    private final LoginInterceptor loginInterceptor;
+    private final UserAuthInterceptor userAuthInterceptor;
+    private final AdminAuthInterceptor adminAuthInterceptor;
+
+    @Override
+    public void addInterceptors(InterceptorRegistry registry) {
+        //유저 로그인 상태 체크 인터셉터
+        registry.addInterceptor(loginInterceptor)
+                .order(1)
+                .addPathPatterns("/**")
+                .excludePathPatterns("/css/**", "/js/**", "/img/**", "/library/**", "*.ico", "/login/**", "/login/logout", "/join/**", "/error");
+        //유저 권한 체크 인터셉터
+        registry.addInterceptor(userAuthInterceptor)
+                .order(2)
+                .addPathPatterns("/**")
+                .excludePathPatterns("/css/**", "/js/**", "/img/**", "/library/**", "*.ico", "/login/**", "/login/logout", "/join/**", "/error", "/admin/**");
+        //관리자 권한 체크 인터셉터
+        registry.addInterceptor(adminAuthInterceptor)
+                .order(3)
+                .addPathPatterns("/admin/**")
+                .excludePathPatterns("/css/**", "/js/**", "/img/**", "/library/**", "*.ico", "/login/**", "/logout", "/join/**", "/error");
+    }
+}

src/main/java/com/effourt/calenkit/config/SpringSecurityConfig.java

@@ -0,0 +1,25 @@
+package com.effourt.calenkit.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.security.config.annotation.web.builders.HttpSecurity;
+import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
+import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
+import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
+import org.springframework.security.crypto.password.PasswordEncoder;
+
+@Configuration
+@EnableWebSecurity
+public class SpringSecurityConfig extends WebSecurityConfigurerAdapter {
+
+    @Override
+    protected void configure(HttpSecurity http) throws Exception {
+        http.httpBasic().disable();
+//        http.csrf().disable(); //csrf 방지 기능 비활성화 -- 테스트용 - 배포 시에 삭제할 것
+    }
+
+    @Bean
+    public PasswordEncoder passwordEncoder() {
+        return new BCryptPasswordEncoder();
+    }
+}