From cc140ca7ce875a925b58d6ac2ffc15c6b3048e6c Mon Sep 17 00:00:00 2001 From: Lee hunil <104710245+Leehunil@users.noreply.github.com> Date: Thu, 23 Nov 2023 20:27:23 +0900 Subject: [PATCH] Update README.md --- README.md | 131 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 128 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5a3e027..07b2afe 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,91 @@ -# ohsoontaxi-sever-v2.0 +# +# 오순택 +순천향대학교 학생들을 위한 택시 동승 매칭 앱 + +
+
+ +## 🚕 오순택을 소개합니다. + +치솟는 택시비… 끊임없는 기다림… + +오순택은 택시 동승을 원하는 학생들과 합승하여 돈과 시간을 절약할 수 있도록 도와주는 서비스예요. --- ![image1](https://github.com/Uttug-Seuja/ohsoontaxi-sever-v2.0/assets/104710245/3d5839e8-da30-4fda-bc8c-cf41152717a2) + +--- + +## 1. 기능을 소개합니다. + +### **`Step 01`. 약속방을 생성합니다.** +- **약속방 생성** + - 제목, 출발지, 도착지, 성별, 약속 시간을 작성하여 약속방을 생성해 택시를 같이 탈 사람을 모집해 보아요. + ![image2](https://github.com/Uttug-Seuja/ohsoontaxi-sever-v2.0/assets/104710245/8473746c-def3-42d2-943a-db886bdcd416) + +### **`Step 02`. 약속방에 참여합니다.** +- **약속방 참여** + - 약속방 리스트와 검색을 통해서 자신이 원하는 약속방에 참여해 보아요. + - 자신이 원하는 약속방의 상세 정보와 참여자 목록을 확인할 수 있어요. + - 자신이 원하는 좌석을 선택할 수 있어요. + ![image3](https://github.com/Uttug-Seuja/ohsoontaxi-sever-v2.0/assets/104710245/77d352f0-f497-426c-ba9c-69de95457928) + +### **`Step 03`. 사용자를 신고하고 온도를 확인합니다.** +- **사용자 신고와 온도 확인** + - 비매너적인 행위를 한 사용자를 신고할 수 있어요. + - 참여 전 참여자들의 온도를 확인할 수 있어요. + - 약속방에 참여를 하여 온도를 높여보아요. + ![image4](https://github.com/Uttug-Seuja/ohsoontaxi-sever-v2.0/assets/104710245/95b5916c-a175-4685-a117-585bc0a4130b) + +### **`Step 04`. 채팅을 통해 소통합니다.** +- **약속방 채팅** + - 채팅을 통해서 참여자들과 소통해 보아요. + ![image5](https://github.com/Uttug-Seuja/ohsoontaxi-sever-v2.0/assets/104710245/fccc55e7-52ac-4b31-9d3c-6ac1cf656635) + +### **`Step 05`. 알림을 통해 약속방 변경을 확인합니다.** +- **약속방 알림** + - 알림을 통해서 약속방의 변경을 쉽게 알 수 있어요. + - 약속 시간 10분 전 알림을 받아보아요. + ![image6](https://github.com/Uttug-Seuja/ohsoontaxi-sever-v2.0/assets/104710245/4ac1a0b1-0618-421e-9540-92dadb5672e5) --- -**##커밋 메세지** +## 2. ERD + +
+
ERD
+ +--- + +## 3. 서버 아키텍쳐 + +
+
Architecture
+--- + +## 4. 기술 스택 +* Java 17 +* Spring Boot 3.0.5 +* Spring Data JPA +* Spring Security +* Redis (pub/sub) +* MariaDB +* Git Action +* AWS Code Deploy +* AWS RDS +* AWS EC2 +* AWS S3 + +--- + +## 5. 커밋 메세지 > 커밋 형식입니다. @@ -20,7 +93,6 @@ 커밋 메세지: 내용 (#number) ``` - |커밋 메세지|설명| |------|---| |:page_facing_up::|파일생성/구조변경| @@ -33,3 +105,56 @@ |:recycle::|코드 리팩토링| |:loud_sound::|로그 추가/수정| |:pencil2::|오타 수정| + +--- + +## 6. 개발자들 + + + + + + + + + + + + + + + +
+ + +
+ Android 🖥 +
+ 조준장 +
+
+ + +
+ BeckEnd 🖥 +
+ 김찬우 +
+
+ + +
+ BeckEnd 🖥 +
+ 이훈일 +
+
+ + +
+ BeckEnd 🖥 +
+ 이건희 +
+
+