From cab3cb10f2646dedb4172fd7de7f84d5f5a3c6f4 Mon Sep 17 00:00:00 2001 From: liyusang1 Date: Sun, 28 Jan 2024 23:21:32 +0900 Subject: [PATCH] =?UTF-8?q?[docs]=20readme=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit readme μΆ”κ°€ --- README.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 63 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5f526cd7..6490d363 100644 --- a/README.md +++ b/README.md @@ -1 +1,63 @@ -# TripComeTrue_BE +### πŸ‘€νŒ€μ› μ†Œκ°œ + +| Backend | Backend |Backend| Backend | Backend | +|:----------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------:|:--------------------------------------------------------------------------------------------:| +| μ΄μœ μƒ | 이주연 | 백인ꢌ | 김동민 | λ°•μ€€λͺ¨ | +| [μ΄μœ μƒ](https://github.com/liyusang1) | [이주연](https://github.com/jo0oy) |[백인ꢌ](https://github.com/BackInGone)| [김동민](https://github.com/meena2003) | [λ°•μ€€λͺ¨](https://github.com/junmo95) | +| πŸ’‘spring security
πŸ’‘νšŒμ›κ°€μž… 및 둜그인
πŸ’‘SNS 둜그인 (카카였,넀이버,ꡬ글)
πŸ’‘μ—¬ν–‰ ν›„κΈ° μž‘μ„±
πŸ’‘μ—¬ν–‰ κ³„νš μž‘μ„± 및 쑰회 | πŸ’‘Github Actions CI/CD, EC2, Docker
πŸ’‘ν™ˆ 메인 ν”Όλ“œ κ΄€λ ¨ api
πŸ’‘ν™ˆ 검색 ν”Όλ“œ κ΄€λ ¨ api
πŸ’‘λ„μ‹œ 상세 κ΄€λ ¨ api
πŸ’‘ν™˜μœ¨ open api μŠ€μΌ€μ€„λŸ¬ 호좜 및 ν™˜μœ¨ 정보 redis μ €μž₯
|πŸ’‘λ§ˆμ΄ νŽ˜μ΄μ§€ κ΄€λ ¨ api
πŸ’‘λ³΄κ΄€ κΈ°λŠ₯ κ΄€λ ¨ api
πŸ’‘μ’‹μ•„μš” κ΄€λ ¨ api | πŸ’‘S3 이미지 μ—…λ‘œλ“œ μ‚­μ œ κ΄€λ ¨ api
πŸ’‘ μ—¬ν–‰ ν›„κΈ° 리뷰 및 λ¦¬λ·°λŒ“κΈ€ κ΄€λ ¨ api
πŸ’‘μ—¬ν–‰μ§€ 리뷰 및 λ¦¬λ·°λŒ“κΈ€ κ΄€λ ¨ api
| πŸ’‘μ—¬ν–‰ ν›„κΈ° λ©”μΈνŽ˜μ΄μ§€ api
πŸ’‘μ—¬ν–‰ ν›„κΈ° μƒμ„ΈνŽ˜μ΄μ§€ api
πŸ’‘μ—¬ν–‰μ§€ μƒμ„ΈνŽ˜μ΄μ§€ api | + +----------------------- +### πŸ“ŒκΈ°μˆ μŠ€νƒ & κ΅¬ν˜„ν™˜κ²½ +> - Java : ![Java](https://img.shields.io/badge/java-17-red.svg) +> - FrameWork : ![Spring Boot](https://img.shields.io/badge/springboot-3.2.1-brightgreen.svg) ![Spring Security](https://img.shields.io/badge/springsecurity-brightgreen.svg) ![Spring Data JPA](https://img.shields.io/badge/spring%20data%20JPA-brightgreen.svg) ![Spring Web](https://img.shields.io/badge/spring%20web-brightgreen.svg) +> - Build : ![Gradle](https://img.shields.io/badge/Build-Gradle-blue.svg) +> - VCS : ![Git](https://img.shields.io/badge/VCS-Git-orange.svg) ![GitHub](https://img.shields.io/badge/Github-black.svg) +> - Database : ![GCP Cloud SQL](https://img.shields.io/badge/Database-AmazonEC2-yellow.svg) +> - DBMS : ![MySQL](https://img.shields.io/badge/DBMS-MySQL-blue.svg) +> - λ°°ν¬ν™˜κ²½ : ![GCP VM](https://img.shields.io/badge/배포%20ν™˜κ²½-AmazonEc2-blue.svg) +> - μ»¨λ²€μ…˜ : ![Code Convention](https://img.shields.io/badge/Code%20Convention-IntelliJ%20Java%20Google%20Style-brightgreen.svg) +> - 브랜치 μ „λž΅ : ![GitFlow](https://img.shields.io/badge/GitFlow-Workflow-orange.svg) + +### πŸ“ŒAPI λͺ…μ„Έμ„œ & μ„œλΉ„μŠ€ 배포 μ£Όμ†Œ +- μ„œλΉ„μŠ€ 배포 μ£Όμ†Œ : [https://tripcometrue.vercel.app](https://tripcometrue.vercel.app) +- API λͺ…μ„Έμ„œ: + - [Postman 1](https://documenter.getpostman.com/view/14269013/2s9YsJCYY9#47909ddc-026a-4731-b0ca-5088b8e8574f) + - [Postman 2](https://documenter.getpostman.com/view/24478928/2s9YsRaUDD) + - [Notion](https://arrow-halibut-e8d.notion.site/API-9d3aa3736a764af6a513efda552211b5?pvs=4) + + +### πŸ“ŒνŒ¨ν‚€μ§€ ꡬ쑰 +``` + com.example.yanolja + β”œβ”€β”€ domain + β”‚ β”œβ”€β”€ alarm + β”‚ β”œβ”€β”€ city + β”‚ β”œβ”€β”€ comment + β”‚ β”œβ”€β”€ likes + β”‚ β”œβ”€β”€ member + β”‚ β”œβ”€β”€ place + β”‚ β”œβ”€β”€ review + β”‚ β”œβ”€β”€ store + β”‚ β”œβ”€β”€ tripplan + β”‚ β”œβ”€β”€ triprecord + β”‚ ... + └── global + β”œβ”€β”€ config + β”œβ”€β”€ entity + β”œβ”€β”€ enums + β”œβ”€β”€ exception + β”œβ”€β”€ jwt + β”œβ”€β”€ s3 + β”œβ”€β”€ springsecurity + β”œβ”€β”€ util + └── validator +``` + +-------------------- + +### ⭐ERD +![erd](https://github.com/TripComeTrue/TripComeTrue_BE/assets/65541248/33ff36cc-0e04-4285-82d4-b2939e77b5ab) + + +### ⭐Project Architecture +![image](https://github.com/TripComeTrue/TripComeTrue_BE/assets/65541248/a6a64b92-2d77-4240-a64e-fe6770e1703e) \ No newline at end of file