From 68b5399ce994c7e3499fe09c698c0b35e43293a0 Mon Sep 17 00:00:00 2001 From: pdohyung <58456758+pdohyung@users.noreply.github.com> Date: Sun, 6 Oct 2024 20:58:42 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20=EB=B0=B1=EC=97=94=EB=93=9C=20README=20?= =?UTF-8?q?=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 123 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 123 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a41b420 --- /dev/null +++ b/README.md @@ -0,0 +1,123 @@ +![jisung_image](https://github.com/user-attachments/assets/7957e811-8bee-4b4c-8ee0-a96048ada2dc) + +## πŸ“‹ ν”„λ‘œμ νŠΈ κ°œμš” + +μƒˆλ‘œμš΄ 책을 읽으렀고 ν•˜λŠ”λ°, λ‚΄μš©μ„ κ³΅μœ ν•˜κ±°λ‚˜ 이미 읽어본 μ‚¬λžŒλ“€κ³Ό 이야기λ₯Ό λ‚˜λˆ„λ©΄ 쒋지 μ•Šμ„κΉŒ ? +책을 읽고, 책에 λŒ€ν•œ 리뷰λ₯Ό 남기고, λ‹€λ₯Έ μ‚¬λžŒλ“€κ³Ό μ†Œν†΅ν•  수 μžˆλŠ” μ„œλΉ„μŠ€λ₯Ό λ§Œλ“€μ–΄λ³΄μž ! + +- μ›ν•˜λŠ” λ„μ„œλ₯Ό 토크방을 톡해 μ‚¬λžŒλ“€κ³Ό 토둠을 진행할 수 μžˆμŠ΅λ‹ˆλ‹€. +- 토크방을 μž…μž₯ν•˜λŠ”λ° κ°„λ‹¨ν•œ μ œμ•½ 쑰건이 μžˆμ„ 수 μžˆμŠ΅λ‹ˆλ‹€. + - ex) ν•΄λ‹Ή 책을 [읽고 μžˆλŠ” μ‚¬λžŒ / 읽은 μ‚¬λžŒ] +- [λ„μ„œ 평가 / 별점 λΆ€μ—¬ / λ…μ„œ μƒνƒœ 기둝 / 의견 μž‘μ„±]이 κ°€λŠ₯ν•©λ‹ˆλ‹€ + +
+ +## πŸ“˜ ν”„λ‘œμ νŠΈ 인원 / κΈ°κ°„ + +- **개발 인원**: [FE 2λͺ… / BE 3λͺ…] +- **개발 κΈ°κ°„**: [2024.03 ~ 2024.05] + +### πŸ–₯️ λ°±μ—”λ“œ μ—­ν•  + +| κΉ€λ„ν˜• | λ°•μ •μš° | μ•ˆμœ€κΈ° | +|:-------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------:| +| | | | +| [pdohyung](https://github.com/pdohyung) | [jwooo](https://github.com/jwooo) | [AHNYUNKI](https://github.com/AHNYUNKI) | +| **[νšŒμ› / 리뷰 / 별점]** 도메인 개발 | **[λ„μ„œ / μ„œμž¬]** 도메인 개발 | **[토크룸 / 의견]** 도메인 개발 | + +
+ +## πŸ› οΈ 기술 μŠ€νƒ + +### πŸ“¦ Language & Framework + +![Java](https://img.shields.io/badge/java-007396?style=for-the-badge&logo=openjdk&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-25A162?style=for-the-badge&logo=&logoColor=white) +![Spring_Boot](https://img.shields.io/badge/spring_boot-6DB33F?style=for-the-badge&logo=springboot&logoColor=white) +![Spring_Rest_Docs](https://img.shields.io/badge/spring_rest_docs-6DB33F?style=for-the-badge&logo=spring&logoColor=white) +![Spring_Data_JPA](https://img.shields.io/badge/spring_data_jpa-6DB33F?style=for-the-badge&logo=spring&logoColor=white) +![QueryDSL](https://img.shields.io/badge/querydsl-6DB33F?style=for-the-badge&logo=spring&logoColor=white) + +### πŸ›’οΈ Database + +![MySQL](https://img.shields.io/badge/mysql-4479A1?style=for-the-badge&logo=MySQL&logoColor=white) +![Redis](https://img.shields.io/badge/redis-DC382D?style=for-the-badge&logo=Redis&logoColor=white) + +### ☁️ Infra + +![AWS_EC2](https://img.shields.io/badge/aws_ec2-FF9900.svg?style=for-the-badge&logo=amazonec2&logoColor=white) +![AWS_RDS](https://img.shields.io/badge/aws_rds-527FFF.svg?style=for-the-badge&logo=amazonrds&logoColor=white) +![AWS_S3](https://img.shields.io/badge/aws_s3-569A31.svg?style=for-the-badge&logo=amazons3&logoColor=white) +![GitHub_Actions](https://img.shields.io/badge/github_actions-2088FF.svg?style=for-the-badge&logo=githubactions&logoColor=white) +![Docker](https://img.shields.io/badge/docker-2496ED.svg?style=for-the-badge&logo=docker&logoColor=white) + +### 🌱 ν”„λ‘œμ νŠΈ ν™˜κ²½ + +> - Java 17 +> - Spring Boot 3.1.9 +> - Gradle 8.5 +> - Git Flow [Feature → Develop → Main] + +
+ +## πŸš€ 핡심 κΈ°λŠ₯ + +### νšŒμ› + +> 카카였 μ†Œμ…œλ‘œκ·ΈμΈμœΌλ‘œ 둜그인과 νšŒμ›κ°€μž… μ œκ³΅ν•©λ‹ˆλ‹€. +> νšŒμ› 정보λ₯Ό μ‘°νšŒν•  수 μžˆμŠ΅λ‹ˆλ‹€. +> νšŒμ›μ΄ μƒμ„±ν•œ [별점 / ν•œμ€„ν‰ / 토크방 / λ…μ„œ μƒνƒœ]λ₯Ό μ‘°νšŒν•  수 μžˆμŠ΅λ‹ˆλ‹€. + +### λ„μ„œ + +> λ„μ„œ κ²€μƒ‰ν•˜κ³  κ²°κ³Όλ₯Ό μ‘°νšŒν•  수 μžˆμŠ΅λ‹ˆλ‹€. +> λ„μ„œμ— λŒ€ν•œ 상세 정보λ₯Ό μ œκ³΅ν•©λ‹ˆλ‹€. +> λ„μ„œμ— λŒ€ν•œ 별점과 λ…μ„œ μƒνƒœλ₯Ό 기둝할 수 μžˆμŠ΅λ‹ˆλ‹€. +> λ„μ„œ λ² μŠ€νŠΈμ…€λŸ¬λ₯Ό μ‘°νšŒν•  수 μžˆμŠ΅λ‹ˆλ‹€. + +### 리뷰 (ν•œμ€„ν‰) + +> λ„μ„œμ— λŒ€ν•œ ν•œμ€„ν‰μ„ μž‘μ„±ν•˜κ³  μ‘°νšŒν•  수 μžˆμŠ΅λ‹ˆλ‹€. +> ν•œμ€„ν‰μ— μ’‹μ•„μš”λ₯Ό 남길 수 μžˆμŠ΅λ‹ˆλ‹€. + +### 별점 + +> λ„μ„œμ— λŒ€ν•œ 별점을 λΆ€μ—¬ν•  수 μžˆμŠ΅λ‹ˆλ‹€. +> λ³„μ μ˜ 평균을 μ‘°νšŒν•  수 μžˆμŠ΅λ‹ˆλ‹€. + +### 토크룸 + +> λ„μ„œλ³„ 토크룸을 μƒμ„±ν•˜κ³  μ°Έκ°€ν•  수 μžˆμŠ΅λ‹ˆλ‹€. +> 토크룸 [정보 / 이미지 / μ°Έμ—¬ 쑰건]을 μ„€μ •ν•  수 μžˆμŠ΅λ‹ˆλ‹€. +> 토크룸에 μ’‹μ•„μš”λ₯Ό 남길 수 μžˆμŠ΅λ‹ˆλ‹€. + +### 의견 + +> 토크방에 μ˜κ²¬μ„ μž‘μ„±ν•  수 μžˆμŠ΅λ‹ˆλ‹€. +> μ˜κ²¬μ— 이미지λ₯Ό μΆ”κ°€ν•  수 μžˆμŠ΅λ‹ˆλ‹€. +> μ˜κ²¬μ— μ’‹μ•„μš”λ₯Ό 남길 수 μžˆμŠ΅λ‹ˆλ‹€. + +
+ +## ⚑ μ£Όμš” μž‘μ—… / PR + +- [μ½”λ“œ 리뷰λ₯Ό 톡해 νŒ€μ›λ“€μ΄ κ°œλ°œν•œ κΈ°λŠ₯ κ²€ν†  및 ν”Όλ“œλ°± 제곡](https://github.com/jisung-in/backend/pull/13) +- [ν…ŒμŠ€νŠΈ μž‘μ„± 및 컀버리지 뢄석을 ν†΅ν•œ κΈ°λŠ₯ μ•ˆμ •μ„± 검증과 ν’ˆμ§ˆ ν–₯상](https://github.com/jisung-in/backend/pull/127) +- [λ„μ„œ λ² μŠ€νŠΈμ…€λŸ¬ 데이터 쑰회 κΈ°λŠ₯에 비동기 처리 적용으둜 μ„±λŠ₯ κ°œμ„ ](https://jwooo.tistory.com/2) +- [νŒ¬ν…€ λ¦¬λ“œ 문제λ₯Ό μœ λ‹ˆν¬ 인덱슀λ₯Ό 톡해 ν•΄κ²°ν•˜μ—¬ μ’‹μ•„μš” 쀑볡 생성 방지](https://trysolve.tistory.com/36) +- [토크룸 쑰회 쿼리 뢄리λ₯Ό ν†΅ν•œ μ„±λŠ₯ κ°œμ„ ](https://github.com/jisung-in/backend/pull/18) + +
+ +## πŸ—οΈ Architecture + +jisungin_architecture + +
+ +## πŸ“ ERD + +![jisungin](https://github.com/user-attachments/assets/35684e3a-0e1a-4964-831b-ea8c991dbdc4) + +