Skip to content

Commit

Permalink
Release/v1.0.2 (#435)
Browse files Browse the repository at this point in the history
* docs: LICENSE 생성

* feat: ERD, 인프라 구조 이미지 업로드

* feat: KEEPER 로고 업로드

* fix: 하드 코딩된 부분을 수정 (#402)

* feat: 키퍼 로고 재업로드

* docs: Create CONTRIBUTING.md

* docs: Create README.md

* test: 깨지는 테스트를 임시적으로 @disabled 처리

* feat: 오타 수정 및 사용 기술 추가 작성

* feat: 관련 링크 추가 작성, 표 형식으로 변경

* fix: IntelliJ 로고 오타 수정

* fix: CONTRIBUTING.md 참조 오타 수정

* docs: 링크 모음을 상단으로 이동, 데이터베이스 레포지토리 링크 추가

* fix: @disalbed 어노테이션 적용해도 test fail이 되는 문제 해결

* fix: 추가된 디펜던시 삭제 및 주석처리

* feat: 퀵 스타트 추가

* docs: 퀵 스타트 가이드 양식 수정

* docs: 링크 주소 수정, 퀵 스타트 가이드 설명 추가

* Feature/#408-JwtTokenFilter와_logout개선 (#409)

* refactor: 다형성을 이용해 토큰을 발행하도록 수정

* refactor: 코드 리뷰 내용을 반영해 List에 의존적이지 않게 수정

* chore: 우테코 -> 구글 포매터로 수정

* chore: 가독성을 위해서 _ 추가

* refactor: interface default method를 사용해 Token의 상태를 확인하도록 수정

* refactor: interface default method를 사용해 SecurityContextHolder에 인증을 넣도록 수정

* fix: sign-out이 401 떨어지도록 수정

* fix: 미사용 클래스 삭제

* fix: accessToken만 valid 해도 시큐리티 컨텍스트에 저장하도록 수정

* feat: 최대 대출 권수 변경

* chore: 최대 권수 변경에 따른 test코드 수정

* feat: 에러코드 추가

BORROW_RENEWAL_ELIGIBILITY_NOT_MET

* feat: LogRepo에서 멤버/책을 기반으로 대출 내역 조회

* feat: 반납일 포함 3일 경과 후 재대출 가능

* chore: 패키지 정리

* chore: query안에 오타 수정

* refactor: 메서드 추출 & 체이닝

* refactor: 에러코드 description 수정

* refactor: borrowStatus가 반납 완료인 것들을 기준으로 책정

* Update issue templates

* delete: CTF 도메인 코드 삭제

* feat: 회원 랭킹 조회 API에 memberId 추가

* fix: 코드 삭제함에 따라 발생한 의존성 및 오류 해결
#399

* test: 선거 도메인 테스트 코드 @disabled 처리
#399

* test: 활동조사 도메인 테스트 코드 @disabled 처리
#399

* refactor: 세미나 출석 정보 조회시 기수와 이름 정렬을 추가한다.

- 기수 순으로 정렬한다.
- 동일 기수 내라면 이름 순으로 정렬한다.

#394

---------

Co-authored-by: 손현경 <[email protected]>
Co-authored-by: stopmin <[email protected]>
Co-authored-by: 정지민 <[email protected]>
Co-authored-by: lcqff <[email protected]>
Co-authored-by: YeonHu Yim <[email protected]>
  • Loading branch information
6 people authored Mar 22, 2024
1 parent 1160f52 commit 2f7dd0b
Show file tree
Hide file tree
Showing 90 changed files with 546 additions and 3,031 deletions.
20 changes: 2 additions & 18 deletions .github/ISSUE_TEMPLATE/bug-template.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
name: bug template
about: 버그 이슈 발행 시 참고하여 이슈를 작성해주시면 됩니다.
title: ''
labels: '🐞 bug'
title: "[BUG]"
labels: "\U0001F41E bug"
assignees: ''

---
Expand All @@ -17,22 +17,6 @@ assignees: ''

> 관련 이슈: #
### 버그 재현

given :

when :

then :

### 예상한 작동과정

given :

when :

then :

## 🤔 그 외 참고 사항 (선택)

> 그 외 전달, 참고 사항이 있다면 작성해주세요.
24 changes: 6 additions & 18 deletions .github/ISSUE_TEMPLATE/feature-template.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,19 @@
---
name: feature template
about: 기능 추가 이슈 발행 시 참고하여 이슈를 작성해주시면 됩니다.
title: ''
labels: '🚀 feature'
title: "[FEAT]"
labels: "\U0001F680 feature"
assignees: ''

---

## 💬 API 기능 설명
## 💬 기능 설명

> 구현하려는 기능 설명을 작성하세요.
> 추가하려는 기능 설명을 작성하세요.
## 📝 API 명세
## 📚 기획 및 참고 사항 (선택)

권한 :

요청 메서드 :

요청 URL :

request :

response : 상태코드 | 응답 필드

## 📚 기획 참고 사항

> 기획서 링크 및 참고 사항을 작성하세요.
> 기획서 및 참고 사항을 작성하세요.
## ☑️ TODO

Expand Down
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
업데이트 예정입니다.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Keeper Homepage Renewal2 Backend Developers

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
166 changes: 166 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
<div align="center">
<img src="./images/logo_neon.svg" width="250" alt="keeper logo"/> <br/>
</div>

# <div align="center">Homepage-Back-R2</div>

KEEPER 홈페이지 백엔드 서버입니다.

## ⭐️ 리뉴얼 프로젝트가 지향하는 바

- 언제나 후임자가 **유지보수하기 좋은 설계 방향**을 고민합니다.
- 캡슐화, 코드 재사용성, 테스트 용이성을 위해 비즈니스 로직을 도메인에 위치시킵니다.
- RESTful API 규칙에 따라 RESTful한 API를 설계하고자 합니다.
- 코드 컨벤션을 정하여 클린 코드를 작성합니다.
- 꼼꼼한 코드 리뷰를 통해 코드의 품질을 높이고, 서로의 작업물을 이해합니다.
- Controller, Service, Repoistory Layer에 대해 테스트 코드를 작성하여 사전에 버그를 방지합니다.

# 📝 링크

| 이름 | 링크 |
|----------------------|------------------------------------------------------------------------------------------------------------------|
| 운영 홈페이지 | [keeper.or.kr](https://keeper.or.kr) |
| 개발 홈페이지 | [dev.keeper.or.kr](https://dev.keeper.or.kr) |
| API 문서 | [api.keeper.or.kr/docs/keeper.html](https://api.keeper.or.kr/docs/keeper.html) |
| Notion | [Notion Link](https://chip-force-ed0.notion.site/KEEPER-0dbccc3c2374465b8be715cd9d872103?pvs=4) |
| 프론트 Repository | [Homepage-Front-R2](https://github.com/KEEPER31337/Homepage-Front-R2) |
| 인프라 코드 Repository | [Homepage-Infrastructure](https://github.com/KEEPER31337/Homepage-Infrastructure) |
| 데이터베이스 코드 Repository | [Homepage-Database](https://github.com/KEEPER31337/Homepage-Database) |

# ✨ 도메인

```
📦 domain
┣ 📂 about // 메인 소개
┣ 📂 attendance // 홈페이지 출석
┣ 📂 auth // 로그인, 회원가입
┣ 📂 comment // 댓글
┣ 📂 file // 파일
┣ 📂 game // 게임
┣ 📂 library // 도서 대출, 관리
┣ 📂 member // 회원 정보 관리
┣ 📂 merit // 상벌점 부여, 관리
┣ 📂 point // 포인트 부여, 관리
┣ 📂 post // 게시글
┣ 📂 seminar // 세미나 출석, 관리
┣ 📂 study // 스터디
┗ 📂 thumbnail // 썸네일
```

# 🛠️ 기술 스택

<div align="center">

**Language**

![Jdk 17](https://img.shields.io/badge/-Jdk%2017-437291?style=for-the-badge&logo=openjdk&logoColor=white)
![Java](https://img.shields.io/badge/-Java-8D6748?style=for-the-badge)
![Kotlin](https://img.shields.io/badge/-kotlin-7F52FF?style=for-the-badge)

**Dependancy**

![Spring Boot 3.0.2](https://img.shields.io/badge/Spring%20boot%203.0.2-6DB33F?style=for-the-badge&logo=springboot&logoColor=white)
![Spring Security](https://img.shields.io/badge/Spring%20security-6DB33F?style=for-the-badge&logo=springsecurity&logoColor=white)
![Spring Rest Docs](https://img.shields.io/badge/Spring%20rest%20docs-6DB33F?style=for-the-badge&logo=springboot&logoColor=white)
![Spring Data Jpa](https://img.shields.io/badge/Spring%20data%20jpa-6DB33F?style=for-the-badge&logo=springboot&logoColor=white)

![Lombok](https://img.shields.io/badge/Lombok-be2e22?style=for-the-badge&logo=lombok&logoColor=white)
![Jwt](https://img.shields.io/badge/Jwt-181717?style=for-the-badge&logo=jwt&logoColor=white)
![p6spy](https://img.shields.io/badge/p6spy-97979A?style=for-the-badge&logo=p6spy&logoColor=white)
![Kotest](https://img.shields.io/badge/Kotest-7F52FF?style=for-the-badge&logo=kotest&logoColor=white)
![JUnit5](https://img.shields.io/badge/JUnit5-25A162?style=for-the-badge&logo=junit5&logoColor=white)
![Mockito](https://img.shields.io/badge/-Mockito-6DB33F?style=for-the-badge)

**Database**

![Mysql 8.0](https://img.shields.io/badge/MySQL%208.0-005C84?style=for-the-badge&logo=mysql&logoColor=white)
![Redis](https://img.shields.io/badge/Redis-DC382D?style=for-the-badge&logo=Redis&logoColor=white)

**Tool**

![Gradle](https://img.shields.io/badge/Gradle%207.6-02303A?style=for-the-badge&logo=gradle&logoColor=white)
![IntelliJ](https://img.shields.io/badge/IntelliJ-000000?style=for-the-badge&logo=intellijidea&logoColor=white)

</div>

# 🌐 인프라, CICD 구조

<div align="center">
<img src="./images/Infra.png" width="500" alt="keeper infra structure"/>
<img src="./images/CICD.png" width="500" alt="keeper cicd structure"/>
</div>

# 🐬 ERD

<div align="center">
<img src="./images/ERD.png" width="600" alt="keeper db erd"/>
</div>

# ⚡️ 퀵 스타트 가이드

아래의 절차를 통해 로컬에서 키퍼 홈페이지를 띄워 보실 수 있습니다.

### STEP 1) 프로젝트 클론

```
git clone https://github.com/02ggang9/Keeper_start_guide.git
```

### STEP 2) .env 파일 생성

quick_start > build > .env 파일 생성 (env.example 파일 참고)

### STEP 3) mail 환경 변수 설정

quick_start > build > docker > data > application.yml 파일 이동 후 mail 환경 변수 설정

### STEP 4) 쉘 스크립트 실행

MAC 환경

```
sh ./run_keeper.sh
```

Ubuntu 환경

```
sudo ./run_keeper.sh
```

### STEP 5) 접속

```
localhost:8080
```

# 🧑🏻‍💻 코드 유지 관리자

<table>
<tr>
<td align="center">
<a href="https://github.com/shkisme">
<img src="https://github.com/shkisme.png" width="80" alt="shkisme"/>
<br/>
<sub><b>shkisme</b></sub>
</a>
<br/>
</td>
<td align="center">
<a href="https://github.com/02ggang9">
<img src="https://github.com/02ggang9.png" width="80" alt="02ggang9"/>
<br />
<sub><b>02ggang9</b></sub>
</a>
<br/>
</td>
</tr>
</table>

### 기여자

[![contributors](https://contrib.rocks/image?repo=KEEPER31337/Homepage-Back-R2)](https://github.com/KEEPER31337/Homepage-Back-R2/graphs/contributors)

### 기여하기

[CONTRIBUTING.md](./CONTRIBUTING.md) 파일을 참고해주세요.
Binary file added images/CICD.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/ERD.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/Infra.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions images/logo_neon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

This file was deleted.

Loading

0 comments on commit 2f7dd0b

Please sign in to comment.