Merge pull request #170 from Leets-Official/docs/#118-readme-작성

[docs] readme 작성
Leets-Official · Feb 5, 2025 · e3e09fc · e3e09fc
2 parents fa44097 + ae5f1ae
commit e3e09fc
Showing 1 changed file with 207 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,207 @@
-# EatMate-BE
+# <img src="https://github.com/user-attachments/assets/7f1bce68-d6d4-490e-8802-787db03e8872" style="height: 1em; vertical-align: middle;"> EatMate
+
+![image](https://github.com/user-attachments/assets/b3b6cc1f-1604-448a-b4a9-decb34bf1de7)
+
+
+## 💫 서비스 소개
+<div align="left">
+<img src="https://github.com/user-attachments/assets/b681a502-0408-4aa4-8bba-efc2fb9f89a6" width="400">
+
+
+> 개발 기간: 2024. 12 ~ 2025. 2  
+
+**"한 끼의 약속, 함께 만들어가는 즐거움"**
+
+혼자 밥을 먹는 건 특별히 어려운 일은 아니다.  
+한 끼의 약속으로 학생들끼리 연결될 수 있다면 더 좋지 않을까?  
+너무 본격적인 만남이 아닌, 부담 없이 함께하는 가벼운 한 끼.  
+때로는 힘들 때 모르는 사람과라도 소소한 이야기를 나누고 싶고,  
+혼자 배달을 시키면서도 누군가와 함께하는 듯한 따뜻함을 느끼고 싶을 때가 있다.  
+EatMate의 목표는 바로 그들의 일상에 따뜻함과 편리함을 더하는 것이다.  
+
+작은 교류 속에서 캠퍼스 생활이 조금 더 즐겁고 따뜻해질 수 있도록,  
+학생들이 부담 없이 연결되고 서로의 일상을 공유할 수 있는 서비스를 제공한다.
+</div>
+
+## 👥 팀원 소개
+
+### Backend
+
+<table>
+  <tr>
+    <td align="center"><img src="https://github.com/ehs208.png" width="160"></td>
+    <td align="center"><img src="https://github.com/seokjun01.png" width="160"></td>
+    <td align="center"><img src="https://github.com/dyk-im.png" width="160"></td>
+    <td align="center"><img src="https://github.com/jj0526.png" width="160"></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/ehs208">은현수</td>
+    <td align="center"><a href="https://github.com/seokjun01">문석준</td>
+    <td align="center"><a href="https://github.com/dyk-im">김동윤</td>
+    <td align="center"><a href="https://github.com/jj0526">전시현</td>
+  </tr>
+  <tr>
+    <td align="center">모임</td>
+    <td align="center">회원</td>
+    <td align="center">채팅</td>
+    <td align="center">인프라, 신고/차단/게시판/이미지</td>
+  </tr>
+    <tr>
+    <td align="center">PO, BE Lead</td>
+    <td align="center">BE</td>
+    <td align="center">BE</td>
+    <td align="center">BE</td>
+  </tr>
+</table>
+
+### Frontend
+
+<table>
+  <tr>
+    <td align="center"><img src="https://github.com/JIN921.png" width="160"></td>
+    <td align="center"><img src="https://github.com/dalzzy.png" width="160"></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/JIN921">이유진</td>
+    <td align="center"><a href="https://github.com/dalzzy">계다현</td>
+  </tr>
+    <tr>
+    <td align="center">FE Lead</td>
+    <td align="center">FE</td>
+  </tr>
+</table>
+
+### Project Manager
+
+<table>
+  <tr>
+    <td align="center"><img src="https://github.com/user-attachments/assets/ae4d7546-f82f-4890-b23c-03cffc779411" width="160" height="160"></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://spangle-ellipse-912.notion.site/f8be40236f9745cd9429f8f86c385e02">이예은</td>
+  </tr>
+    <tr>
+    <td align="center">Project Manager</td>
+  </tr>
+</table>
+
+
+### Designer
+
+<table>
+  <tr>
+    <td align="center"><img src="https://github.com/user-attachments/assets/d2be5be9-f789-4f83-9215-493effddd69e" width="160" height="160"></td>
+
+  </tr>
+  <tr>
+    <td align="center"><a href="https://www.behance.net/6c6bd374">진소이</td>
+  </tr>
+    <tr>
+    <td align="center">Designer</td>
+  </tr>
+</table>
+
+## 📱 주요 기능
+
+- **학교 이메일 인증을 통한 대학생 전용 서비스**  
+    - 학교 도메인 이메일로만 회원가입 가능  
+    - 재학생/졸업생 인증으로 안전한 커뮤니티 조성  
+
+- **다양한 유형의 식사 모임**
+    - 배달 모임: 배달비 절약과 다양한 메뉴 공유  
+    - 밥약/술약: 캠퍼스 근처 맛집 탐방과 친목 도모  
+    - 카테고리별 모임 검색 (치킨, 피자, 중식, 일식 등)  
+
+- **안전한 모임 환경 조성**  
+   - 성별 기반 참여 제한 (남성/여성 전용, 혼성)  
+   - 모임 인원 제한 설정 (2-10명)  
+   - 신고 및 차단 시스템  
+   - 차단된 사용자와는 모임 매칭 제한  
+
+- **실시간 소통**  
+   - 모임별 채팅방 자동 생성  
+   - 실시간 참여자 소통  
+
+- **편리한 모임 관리 시스템**  
+   - 주문 마감시간/모임시간 자동 관리  
+   - 참여중인 모임 목록 제공  
+   - 다양한 정렬 방식 지원 (생성순/시간순/인원순)
+   - 모임 상태 자동 관리 (시간 경과시 자동 비활성화) 
+
+## 💻 화면
+
+<table align="center" style="border-collapse: collapse; width: 100%; max-width: 1200px; margin: 20px auto;">
+    <tr>
+        <td align="center" style="width: 50%; padding: 10px;">
+            <img src="https://github.com/user-attachments/assets/877fc54b-6c0c-47f3-a880-b2c1e311c244" alt="회원가입" style="width: 100%; max-width: 500px;">
+            <p align="center"><strong>회원가입</strong></p>
+        </td>
+        <td align="center" style="width: 50%; padding: 10px;">
+            <img src="https://github.com/user-attachments/assets/5c413b0f-e2e8-48c6-ba38-808b56cca660" alt="홈" style="width: 100%; max-width: 500px;">
+            <p align="center"><strong>홈</strong></p>
+        </td>
+    </tr>
+    <tr>
+        <td align="center" style="width: 50%; padding: 10px;">
+            <img src="https://github.com/user-attachments/assets/508bec43-5820-44f7-aba1-82cfb84ae767" alt="모임 상세" style="width: 100%; max-width: 500px;">
+            <p align="center"><strong>모임 상세</strong></p>
+        </td>
+        <td align="center" style="width: 50%; padding: 10px;">
+            <img src="https://github.com/user-attachments/assets/eacdd2d2-373e-4dc5-813f-69126c6935d4" alt="채팅" style="width: 100%; max-width: 500px;">
+            <p align="center"><strong>채팅</strong></p>
+        </td>
+    </tr>
+    <tr>
+        <td align="center" style="width: 50%; padding: 10px;">
+            <img src="https://github.com/user-attachments/assets/8b630ab6-cce8-457c-883d-5a05074668ce" alt="모임 생성" style="width: 100%; max-width: 500px;">
+            <p align="center"><strong>모임 생성</strong></p>
+        </td>
+        <td align="center" style="width: 50%; padding: 10px;">
+            <img src="https://github.com/user-attachments/assets/884b451e-fcbe-4761-86ef-917d3a6612dc" alt="마이 페이지" style="width: 100%; max-width: 500px;">
+            <p align="center"><strong>마이페이지</strong></p>
+        </td>
+    </tr>
+    <tr>
+        <td align="center" style="width: 50%; padding: 10px;">
+            <img src="https://github.com/user-attachments/assets/9289b26c-34b6-49ed-9798-92673b789a1c" alt="차단/신고" style="width: 100%; max-width: 500px;">
+            <p align="center"><strong>차단/신고</strong></p>
+        </td>
+        <td align="center" style="width: 50%; padding: 10px;">
+            <!-- 빈 셀 -->
+        </td>
+    </tr>
+</table>
+
+
+## ⚙️ 아키텍처 구조
+
+![image](https://github.com/user-attachments/assets/81aa4c6d-3579-48df-9d91-feb5062d240d)
+
+## 🛠️ 기술 스택
+
+### Backend
+
+![Spring Boot](https://img.shields.io/badge/Spring%20Boot-6DB33F?style=flat&logo=springboot&logoColor=white)
+![Spring Security](https://img.shields.io/badge/Spring%20Security-6DB33F?style=flat&logo=springsecurity&logoColor=white)
+![JPA](https://img.shields.io/badge/JPA-007396?style=flat&logo=hibernate&logoColor=white)
+![RabbitMQ](https://img.shields.io/badge/RabbitMQ-FF6600?style=flat&logo=rabbitmq&logoColor=white)
+![MySQL](https://img.shields.io/badge/MySQL-4479A1?style=flat&logo=mysql&logoColor=white)
+![QueryDSL](https://img.shields.io/badge/QueryDSL-E74C3C?style=flat&logo=querydsl&logoColor=white)
+
+### Infra
+
+![AWS S3](https://img.shields.io/badge/AWS%20S3-569A31?style=flat&logo=amazons3&logoColor=white)
+![AWS EC2](https://img.shields.io/badge/AWS%20EC2-FF9900?style=flat&logo=amazonec2&logoColor=white)
+![Caddy](https://img.shields.io/badge/Caddy-1F1F1F?style=flat&logo=caddy&logoColor=white)
+![Docker](https://img.shields.io/badge/Docker-2496ED?style=flat&logo=docker&logoColor=white)
+![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-2088FF?style=flat&logo=githubactions&logoColor=white)
+
+### Collaboration Tool
+![GitHub](https://img.shields.io/badge/GitHub-181717?style=flat&logo=github&logoColor=white)
+![Trello](https://img.shields.io/badge/Trello-0052CC?style=flat&logo=trello&logoColor=white)
+![Notion](https://img.shields.io/badge/Notion-000000?style=flat&logo=notion&logoColor=white)
+![Slack](https://img.shields.io/badge/Slack-4A154B?style=flat&logo=slack&logoColor=white)
+![Zep](https://img.shields.io/badge/Zep-6758FF?style=flat&logoColor=white)
+
+
+