diff --git a/README.md b/README.md index 3add0a2a8..aa9988894 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@
- keeper logo
+ keeper logo
#
Homepage-Back-R2
@@ -8,10 +8,10 @@ KEEPER 홈페이지 백엔드 서버입니다. ## ⭐️ 리뉴얼 프로젝트가 지향하는 바 -- 언제나, 후임자가 **유지보수하기 좋은 설계 방향**을 고민합니다. +- 언제나 후임자가 **유지보수하기 좋은 설계 방향**을 고민합니다. - 캡슐화, 코드 재사용성, 테스트 용이성을 위해 비즈니스 로직을 도메인에 위치시킵니다. -- RESTful API 규칙에 따라 API를 설계하고자 합니다. -- 코드 컨벤션을 정하여 클린 코드를 작성하고자 합니다. +- RESTful API 규칙에 따라 RESTful한 API를 설계하고자 합니다. +- 코드 컨벤션을 정하여 클린 코드를 작성합니다. - 꼼꼼한 코드 리뷰를 통해 코드의 품질을 높이고, 서로의 작업물을 이해합니다. - Controller, Service, Repoistory Layer에 대해 테스트 코드를 작성하여 사전에 버그를 방지합니다. @@ -26,7 +26,7 @@ KEEPER 홈페이지 백엔드 서버입니다. ┣ 📂 file // 파일 ┣ 📂 game // 게임 ┣ 📂 library // 도서 대출, 관리 - ┣ 📂 member // 회원 관리 + ┣ 📂 member // 회원 정보 관리 ┣ 📂 merit // 상벌점 부여, 관리 ┣ 📂 point // 포인트 부여, 관리 ┣ 📂 post // 게시글 @@ -38,35 +38,50 @@ KEEPER 홈페이지 백엔드 서버입니다. # 🛠️ 기술 스택
- - ![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) - - ![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) - - ![Gradle](https://img.shields.io/badge/Gradle%207.6-02303A?style=for-the-badge&logo=gradle&logoColor=white) - ![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) - ![JUnit5](https://img.shields.io/badge/JUnit5-25A162?style=for-the-badge&logo=junit5&logoColor=white) - ![Mockito](https://img.shields.io/badge/-Mockito-181717?style=for-the-badge) - + +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=intellij&logoColor=white) +
# 🌐 인프라, CICD 구조
- keeper infra structure - keeper cicd structure + keeper infra structure + keeper cicd structure
# 🐬 ERD
- keeper db erd + keeper db erd
# ⚡️ 퀵 스타트 @@ -107,4 +122,4 @@ KEEPER 홈페이지 백엔드 서버입니다. ### 기여하기 -[CONTRIBUTING.md](/CONTRIBUTING.md) 파일을 참고하시면 됩니다. +[CONTRIBUTING.md](/CONTRIBUTING.md) 파일을 참고해주세요.