Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

document/Refactor README.md #141

Merged
merged 1 commit into from
Aug 23, 2023
Merged

document/Refactor README.md #141

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
274 changes: 130 additions & 144 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,141 +1,21 @@
# 🏠 Hello There - 공동주택 커뮤니티
# 🏠 공동 주택 커뮤니티 App - Hello There

<div align="center">
<img src="./image/hellothere.png" height="250">
<img src="./image/hellothere.png" height="450">
</div>

## 프로젝트 소개

### **Hello There**는 이웃간의 소통을 통해 바람직한 이웃 문화의 발전을 위한 앱 서비스입니다.

> 이웃에 무관심한 현대사회에서 서로의 소통은 더욱 힘들어지고 있습니다. **1인 가구의 사회적 고립**은 심화되고있고 **층간 소음**은 사회적 문제로 떠오른지 오래입니다.
>
> Hello There은 **소통, 연결, 나눔**을 키워드로 이웃과의 소통 창구를 만들어 사회적 문제를 해결하고자합니다.

## 📋 목차

<ol>
<li><a href="#dev">개발 배경</a></li>
<li><a href="#feature">기능 설명</a></li>
<li><a href="#figma">피그마</a></li>
<li><a href="#stacks">기술 스택</a></li>
<li><a href="#erd">ERD</a></li>
<li><a href="#api">API 명세서</a></li>
<li><a href="#cop">협업</a></li>
<li><a href="#teaminfo">팀 정보</a></li>
</ol>

<h2 id="dev">개발 배경</h2>

<div align="center"><a href="https://www.makeus.in/umc">
<img src="./image/umc.png" height="100"></a>
</div>

Hello There은 UMC 4기 프로젝트 활동으로 시작됐습니다.

> Project Manager, Designer, FrontEnd, BackEnd 총 8명으로 진행했습니다.

### 개발 기간

**23/07/01 ~ 23/08/23**

<h2 id="feature"> 📱 기능 설명 </h2>

### 🧑‍💻 OAuth으로 간편한 소셜 로그인

Spring Security 와 OAuth 기반으로 간편한 소셜로그인이 가능합니다.

> Kakao, Google 로그인 지원

소셜로그인이 아닌 JWT를 이용한 앱 자체 로그인 기능도 지원합니다.

> 리프레시토큰을 이용해 액세스토큰의 보안적 단점을 보완했습니다.

### 🛰️ GPS 기반의 주택 커뮤니티 찾기

**GPS기반으로** 쉽고 간편하게 자신이 속한 주택 커뮤니티에 접속할 수 있습니다.

### 📝 다양한 게시판

- 자유로운 소통을 위한 **자유게시판**
- 이웃간의 갈등 해결을 위한 **갈등 소통 게시판**
- 거주지 인근의 유용한 정보를 나누는 **정보 공유 게시판**
- 공구와 중고 물품을 거래할 수 있는 **공구/중고 게시판**
- 인터리어를 공유할 수 있는 **나만의 홈테리어 게시판**

### 👫 이웃간 실시간 소통 (Chatting)

Hello There은 **1:1채팅 그룹채팅**을 지원합니다.

채팅을 통해 **더 빠르고 유용한 정보**를 나눌 수 있습니다.

### 🔔 푸시 알람

푸시 알람을 통해 사용자는 빠르게 커뮤니티 알람을 받아볼 수 있습니다.

댓글, 대댓글, 인기게시글 선정 등 원하는 알림을 On/Off 할 수 있습니다.

### 📈 관리비 기록 및 추적

매월 관리비를 기록하고 월별 관리비를 추적할 수 있습니다.

### 🔈 지역광고

Hello There의 수익모델입니다.

지역광고를 통해 **지역경제 활성화**를 돕습니다.

<h2 id="figma"> 🎆 피그마</h2>

<div align="center">
<img src="./image/figma.png" height="100">
</div>

> 디자이너의 결과물을 팀원 모두 공유하여 의견을 수렴해 진행했습니다.
>
> 이미지 클릭 시 피그마 페이지로 이동합니다.

<h2 id="stacks">⚒️ 기술 스택</h2>

<div align="center"><a href="https://www.figma.com/file/9wxIvelTAROHpKgBXLpWsm/UMC4th_HelloThere?type=design&node-id=0-1&mode=design&t=JGrHDwFWM2EideWs-0">
<img src="./image/stacks.png" height="400"></a>
</div>

<h3>Java 17, Spring Boot, JPA, MySQL 기반으로 구현</h3>

<h2 id="erd">🧩 ERD </h2>

<div align="center">
<img src="./image/erd.png" height="400">
</div>

[상세 DDL 링크](https://www.notion.so/ERD-52815e58621b4947b61ae370f7c0315e?pvs=4)

<h2 id="api"> API </h2>

[API 명세서 링크](https://www.notion.so/API-eaf0d2d78321436c9b16bb79c03e228f?pvs=4)

<h2 id="cop"> 🧑‍💻 협업</h2>

### Issue

<div align="center">
<img src="./image/issue.png" height="200">
</div>

> 이슈 템플릿을 이용해 팀원 모두 템플릿을 기반으로 이슈를 작성했습니다.
>
> 이슈 템플릿은 해당 이슈에서 어떤 작업을 처리하는지 이해하기 쉽게 해줍니다.

### Pull Request

<div align="center">
<img src="./image/pr.png" height="200">
</div>

> PR 네이밍을 refactor, feature, test, remove 로 시작하여 해당 pr의 목적을 분명히 하도록 했습니다.

<h2 id="teamInfo"> 👨‍👨‍👦‍👦 팀 정보</h2>
**Hello There**는 이웃집 커뮤니티 어플리이션으로, 바람직한 이웃 문화를 장려하기 위해 제작된 서비스입니다. Hello There 어플리케이션은 UMC 4th Study를 수료한 인하대학교, 가톨릭대학교, 한국공학대학교 학생들이 함께 제작하였으며, Project Manager, Designer, FrontEnd, BackEnd로 구성된 총 9명의 팀원이 참여하였습니다.
<br>
<br>
## 👨‍🏫 프로젝트 소개
Hello There 어플리케이션의 주요 키워드는 **소통, 연결, 나눔**입니다.
> **소통**: 이웃 간의 불화, 다툼, 언쟁을 해결할 수 있는 소통 창구로써의 역할을 수행합니다.
>
> **연결**: 정보 및 인테리어 공유, 채팅 등의 서비스를 통해 이웃 간의 원활한 상호 교류를 유도합니다.
>
> **나눔**: 중고거래, 공동구매 등 이웃 간 공유경제를 활성화 할 수 있는 다양한 서비스를 제공합니다.
<br>
<h2 id="teamInfo"> 👨‍👨‍👦‍👦 개발자 소개</h2>

<table width="950">
<thead>
Expand All @@ -145,46 +25,45 @@ Hello There의 수익모델입니다.
<th>사진</th>
<td width="100" align="center">
<a href="https://github.com/gmlstjq123">
<img src="./image/byeon.jpeg" width="60" height="60">
<img src="./image/byeon.jpeg" width="150" height="150">
</a>
</td>
<td width="100" align="center">
<a href="https://github.com/rossssa">
<img src="./image/lee.png" width="60" height="60">
<img src="./image/lee.png" width="150" height="150">
</a>
</td>
<td width="100" align="center">
<a href="https://github.com/songhaechan">
<img src="./image/song.jpeg" width="60" height="60">
<img src="./image/song.jpeg" width="150" height="150">
</a>
</td>
<td width="100" align="center">
<a href="https://github.com/duddn2012">
<img src="./image/go.png" width="60" height="60">
<img src="./image/go.png" width="150" height="150">
</a>
</td>
</tr>
<tr>
<th>이름</th>
<td width="100" align="center">변현섭</td>
<td width="100" align="center">팀장 / 변현섭</td>
<td width="100" align="center">이다빈</td>
<td width="100" align="center">송해찬</td>
<td width="100" align="center">고영우</td>
</tr>
<tr>
<th>역할</th>
<td width="150" align="center">
팀장<br>
백엔드
유저, 아파트,<br> 소셜로그인
</td>
<td width="150" align="center">
백엔드
게시판, 댓글,<br> 좋아요
</td>
<td width="150" align="center">
백엔드
게시판, 댓글,<br> 유저 신고
</td>
<td width="150" align="center">
백엔드
유저, 알림,<br> 아파트
</td>
</tr>
<tr>
Expand Down Expand Up @@ -235,3 +114,110 @@ Hello There의 수익모델입니다.
</tr>
</tbody>
</table>
<br>

## ⏲️ 개발 기간
- **프로젝트 기간**: 2023.07.01(일) ~ 2023.08.23(수)
- **전체 회의**: 매주 월요일 오후 6시
- **Backend 파트 회의**: 매주 일요일 오후 6시
- **FrontEnd & BackEnd 연합 회의**: 매주 수요일 오후 10시
<br>
<br>
## 📝 프로젝트 아키텍쳐
<div align="center"><a href="https://www.figma.com/file/9wxIvelTAROHpKgBXLpWsm/UMC4th_HelloThere?type=design&node-id=0-1&mode=design&t=JGrHDwFWM2EideWs-0">
<img src="./image/stacks.png" height="650"></a>
</div>

## ✒️ 협업 규칙
**1. 브랜치 전략**: Gihub Flow 전략 사용

**2. Issue 네이밍 규칙**: 명확한 의도를 나타낼 수 있도록 한글로 작성

**3. Pull Request 네이밍 규칙**:<br>
> 새로운 기능 추가 → feature/기능명<br>
> 기존 내용 수정 → refactor/기능명 or fix/issue-#number<br>
> 기존 내용 삭제 → remove/기능명<br>
> 문서 관련 처리 → document/기능명

**4. Commit Message 네이밍 규칙**: 이슈 네임과 동일
<br>
<br>

## 💻 개발환경
- **Version** : Java 17, Python 3.10.12
- **IDE** : IntelliJ, Visual Studio Code
- **Framework** : SpringBoot 2.7.11
- **ORM** : JPA
<br>

## ⚙️ 기술 스택
- **Server**: EC2
- **Load Balancing**: Auto Scaling, ELB
- **DNS**: Route 53, ACM
- **DataBase**: RDS, Datagrip, JPQL, ERD AqueryTool, S3, Redis
- **WS/WAS**: Nginx, Tomcat
- **CI/CD**: Github Actions, CodeDeploy, S3
- **협업 관리**: Notion, Google Meet, Discord, Github, Figma
- **기타**: Firebase, SQS, Lambda, CloudWatch, SNS
<br>

## 📱 기능 설명

### ✍ 소셜 로그인 서비스
> ✔ 구글, 네이버, 카카오 계정을 이용한 간편 회원가입 서비스를 제공합니다.<br>
> ✔ 앱 자체 로그인 기능도 지원합니다.
<br>

### 🛰️ 본인 주택 등록 서비스
> ✔ GPS를 이용해 본인의 주택을 더욱 편리하게 등록할 수 있습니다.<br>
> ✔ 본인이 등록한 주택의 커뮤니티로 자동 연결됩니다.
<br>

### 📝 이웃 게시판 서비스
> ✔ 자유로운 소통을 위한 **자유게시판**<br>
> ✔ 이웃간의 갈등 해결을 위한 **갈등 소통 게시판**<br>
> ✔ 거주지 인근의 유용한 정보를 나누는 **정보 공유 게시판**<br>
> ✔ 공구와 중고 물품을 거래할 수 있는 **공구/중고 게시판**<br>
> ✔ 인터리어를 공유할 수 있는 **나만의 홈테리어 게시판**<br>
<br>

### 👫 실시간 채팅 서비스
> ✔ 게시판에서 알게 된 이웃과 채팅을 실시간으로 주고 받을 수 있습니다.<br>
> ✔ 개인 및 단체 채팅 기능을 모두 지원합니다.
<br>

### 🔔 푸시 알림
> ✔ 푸시 알림을 통해 댓글, 대댓글, 인기게시글 선정 등의 푸시 알림을 받을 수 있습니다.<br>
> ✔ 푸시 알림을 원하지 않을 시 직접 원하는 알림을 On/Off 할 수 있습니다.
<br>

### 📈 관리비 기록 및 추적
> ✔ 매월 관리비를 기록함으로써, 월별 관리비 사용 내역을 추적할 수 있습니다.
<br>

### 🔈 지역광고
> ✔ 연락처와 광고 개요만 입력하여 누구나 쉽게 지역광고를 문의할 수 있습니다.
<br>

### 📣 유저 신고
> ✔ 부적절한 게시글, 댓글, 대댓글, 채팅에 대해 해당 유저를 신고할 수 있습니다.<br>
> ✔ 누적 신고 횟수 및 신고 종류에 따라 게시글, 채팅, 댓글 기능 이용이 수일 동안 제한됩니다.
<br>

UI/UX 디자인: <https://www.figma.com/file/9wxIvelTAROHpKgBXLpWsm/UMC4th_HelloThere?type=design&node-id=0-1&mode=design&t=zsw87B0sTsoYX0hm-0>
<br>
<br>

<h2 id="erd">🧩 ERD </h2>

<div align="center">
<img src="./image/erd.png" height="400">
</div>
<br>
<br>

<h2 id="api"> 📌 API </h2>

API 명세서: <https://www.notion.so/API-eaf0d2d78321436c9b16bb79c03e228f?pvs=4>


Loading