Skip to content

Commit 5cdf478

Browse files
m-a-kingm-a-king
committed
docs: readme 업데이트
1 parent 0bf8234 commit 5cdf478

File tree

1 file changed

+55
-29
lines changed

1 file changed

+55
-29
lines changed

‎README.md‎

Lines changed: 55 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,74 @@
11
![somemore_logo2](https://github.com/user-attachments/assets/dc84b70c-66d6-48dd-a8f7-506fb14e83b5)
22

3-
## WEB_1_1_Bongdari_BE
3+
## Bongdari_BE
44

5-
Programmers DevCourse BE 1기 최종 8팀 프로젝트 - 백엔드
5+
Programmers DevCourse BE 1기 8팀 최종 프로젝트 - 백엔드
66

7-
▶️ [Notion](https://www.notion.so/prgrms/Team08-81045d7e1f3e48ccbb9b215a663b97c6?pvs=4)
7+
## ▶️ [손모아 사이트](https://www.somemore.site/)
8+
9+
## ▶️ [Notion](https://www.notion.so/prgrms/Team08-81045d7e1f3e48ccbb9b215a663b97c6?pvs=4)
810

911
***
1012

1113
## 🧑‍🧑‍🧒‍🧒 Team
12-
|조재중 (팀장)|윤서진 (PM)|양아영|이범수|
13-
|:---:|:---:|:---:|:---:|
14-
|인증/인가, SSE 기반 알림, 봉사자|기관 프로필/관심기관/쪽지, 프로젝트 배포|커뮤니티 게시판/댓글, elasticsearch 기반 검색|봉사 활동 모집/지원, 봉사 활동 관리/리뷰|
15-
|[m-a-king](https://github.com/m-a-king)|[7zrv](https://github.com/7zrv)|[ayoung-dev](https://github.com/ayoung-dev)|[leebs0521](https://github.com/leebs0521)
16-
|![](https://avatars.githubusercontent.com/u/126754298?v=4)|![](https://avatars.githubusercontent.com/u/90759319?v=4)|![](https://avatars.githubusercontent.com/u/52439725?v=4)|![](https://avatars.githubusercontent.com/u/86824224?v=4)|
1714

18-
***
15+
| 조재중 (팀장) | 윤서진 (PM) | 양아영 | 이범수 |
16+
|:----------------------------------------------------------:|:---------------------------------------------------------:|:---------------------------------------------------------:|:---------------------------------------------------------:|
17+
| 인증/인가, SSE 기반 알림, 봉사자 | 기관 프로필/관심기관/쪽지, 프로젝트 배포 | 커뮤니티 게시판/댓글, elasticsearch 기반 검색 | 봉사 활동 모집/지원, 봉사 활동 관리/리뷰 |
18+
| [m-a-king](https://github.com/m-a-king) | [7zrv](https://github.com/7zrv) | [ayoung-dev](https://github.com/ayoung-dev) | [leebs0521](https://github.com/leebs0521)
19+
| ![](https://avatars.githubusercontent.com/u/126754298?v=4) | ![](https://avatars.githubusercontent.com/u/90759319?v=4) | ![](https://avatars.githubusercontent.com/u/52439725?v=4) | ![](https://avatars.githubusercontent.com/u/86824224?v=4) |
1920

21+
***
2022

2123
# 1. 개요
2224

2325
## 프로젝트 소개
26+
2427
![somemore_logo](https://github.com/user-attachments/assets/a5ec03a0-bdac-46ea-841d-b86dcdc769dc)
28+
2529
### 자원 봉사자 구호활동 연결 플랫폼 : 손모아(SOMEMORE)
26-
손모아(SomeMore)는 재해나 자원이 필요한 현장에서 도움을 원하는 단체와 자원봉사자를 연결하는 중계 플랫폼입니다.
2730

28-
자원이 필요한 기관의 정보를 한눈에 확인하고, 자신의 능력과 자원에 맞는 구호 활동에 참여할 수 있도록 돕습니다.
31+
> 손모아(SomeMore)는 재해나 자원이 필요한 현장에서 도움을 원하는 단체와 자원봉사자를 연결하는 중계 플랫폼입니다.
32+
> 자원이 필요한 기관의 정보를 한눈에 확인하고, 자신의 능력과 자원에 맞는 구호 활동에 참여할 수 있도록 돕습니다.
33+
34+
###
35+
36+
### 기획 배경
2937

30-
#### 기획 배경
3138
> 재해 현장이나 공익을 위한 활동에서 자원봉사자와 단체 간의 연결은 여전히 불편하고 번거로운 절차를 요구합니다.
32-
> 기존 봉사 플랫폼의 관료적 절차를 개선하고 즉각적인 매칭 시스템을 구축하고자, 손모아는 봉사자와 기관이 **상호 주체적인 역할**을 통해 직접적으로 소통하고, 효율적으로 활동을 이어나갈 수 있도록 돕는 플랫폼을 기획했습니다.
33-
> 이로 지원봉사 문화의 접근성이 향상되고, 지속 가능한 사회 공헌 생태계가 구축될 것을 기대할 수 있습니다.
34-
**핵심 가치**
39+
> 기존 봉사 플랫폼의 관료적 절차를 개선하고 즉각적인 매칭 시스템을 구축하고자, 손모아는 봉사자와 기관이 **상호 주체적인 역할**을 통해 직접적으로 소통하고, 효율적으로 활동을 이어나갈 수 있도록 돕는 플랫폼을
40+
> 기획했습니다.
41+
> 이로 지원봉사 문화의 접근성이 향상되고, 지속 가능한 사회 공헌 생태계가 구축될 것을 기대합니다.
42+
43+
###
44+
45+
### 핵심 가치
46+
3547
- 연결: 도움이 필요한 곳과 봉사자를 직접 연결
3648
- 자율성: 기관과 봉사자 모두에게 주도적인 참여 기회 제공
3749

50+
###
3851

3952
📄 [프로젝트 기획서](https://www.notion.so/prgrms/96e6ee529a8a42ada5ccdcbb13ffbb81?pvs=4)
4053

41-
## 개발 기간
42-
2024/11/12 ~ 개발 중
54+
### 개발 기간
55+
56+
> 2024/11/12 ~ 개발 중
4357
4458
---
4559

4660
# 2. 주요 기능
4761

4862
- 로그인/회원가입
63+
- OAuth, ID/PW
64+
- JWT
4965
- 도움 요청글
5066
- 커뮤니티
5167
- 커뮤니티 글 작성, 조희, 수정, 삭제
5268
- 커뮤니티 댓글(대댓글) 작성, 조회, 수정, 삭제
5369
- 랭킹
5470
- 알림
71+
- SSE
5572
- 검색
5673
- 도움 요청글 위치 기반 검색
5774
- 도움 요청글 제목, 내용 키워드 검색
@@ -61,16 +78,19 @@ Programmers DevCourse BE 1기 최종 8팀 프로젝트 - 백엔드
6178
---
6279

6380
# 3. 시스템 아키텍처
81+
6482
![somemore_service](https://github.com/user-attachments/assets/0b3ab011-fc3e-442b-8aac-37de286a589a)
6583

6684
---
6785

6886
# 4. ERD
87+
6988
![somemore ERD](https://github.com/user-attachments/assets/2a2091da-b6bf-4db3-8855-652467f656e9)
7089

7190
---
7291

7392
# 5. WBS / 요구사항 명세
93+
7494
<img width="1350" alt="스크린샷 2024-12-10 오전 10 30 37" src="https://github.com/user-attachments/assets/49333eb7-c874-4152-bf26-79a39e5d70bc">
7595

7696
📺 [WBS](https://docs.google.com/spreadsheets/d/1BJ6unqhGYQMf1ZQvwPXxzdWcs8Djv224Yi5jLE-sD3M/edit?gid=1991800281#gid=1991800281)
@@ -80,6 +100,7 @@ Programmers DevCourse BE 1기 최종 8팀 프로젝트 - 백엔드
80100
---
81101

82102
# 6. API 명세
103+
83104
<img width="1456" alt="스크린샷 2024-12-10 오전 10 19 53" src="https://github.com/user-attachments/assets/3a4f0762-468f-4368-bdf9-13eb68e39e09">
84105

85106

@@ -90,38 +111,43 @@ Programmers DevCourse BE 1기 최종 8팀 프로젝트 - 백엔드
90111
---
91112

92113
# 7. 트러블 슈팅
114+
93115
🚀 [트러블 슈팅](https://www.notion.so/prgrms/1e34c1f077404fd7a87b4ac670b5b43c?v=1433e47046bf811aa93a000ca3880ec5&pvs=4)
94116

95117
---
96118

97119
# 8. 성능 개선기
120+
98121
❤️‍🩹 [성능 개선기](https://www.notion.so/prgrms/de9f07e7d91845bb9ed15efb4a4e7092?v=1573e47046bf810980eb000c74210814&pvs=4)
99122

100123
---
101124

102125
# 9. ADR
126+
103127
🤔 [Architectural Decision Records](https://www.notion.so/prgrms/ADR-7648f69a1b4a4ca6ace47d7828d27015?pvs=4)
104128

105129
---
106130

107131
# 9. 개발 환경
132+
108133
- OS : Mac
109134
- IDE : JetBrain IntelliJ
110135

111-
| Software | 세부 Spec 사양 (Version) |
112-
| --- | --- |
113-
| Java | jdk 21 |
114-
| Spring Boot | 3.3.5 |
115-
| Spring Boot Libraries | Oauth2, Security, Lombok, MySQL Connector, Swagger v3 |
116-
| SonarQube | 5.1.0.4882 |
117-
| AWS | awssdk:2.29.20 |
118-
| QueryDSL | JPA: 5.0.0 |
119-
| Redisson | 3.37.0 |
120-
| Jwt | 0.12.6 |
121-
| Elasticsearch/Kibana/Logstash | 8.16.1 |
122-
| Redis | spring-boot-starter-data-redis |
136+
| Software | 세부 Spec 사양 (Version) |
137+
|-------------------------------|-------------------------------------------------------|
138+
| Java | jdk 21 |
139+
| Spring Boot | 3.3.5 |
140+
| Spring Boot Libraries | Oauth2, Security, Lombok, MySQL Connector, Swagger v3 |
141+
| SonarQube | 5.1.0.4882 |
142+
| AWS | awssdk:2.29.20 |
143+
| QueryDSL | JPA: 5.0.0 |
144+
| Redisson | 3.37.0 |
145+
| JJWT | 0.12.6 |
146+
| Elasticsearch/Kibana/Logstash | 8.16.1 |
147+
| Redis | spring-boot-starter-data-redis |
123148

124149
***
125150

126151
## 기술스택
152+
127153
<img src="https://img.shields.io/badge/java-007396?style=for-the-badge&logo=java&logoColor=white"> <img src="https://img.shields.io/badge/mysql-4479A1?style=for-the-badge&logo=mysql&logoColor=white"> <img src="https://img.shields.io/badge/spring-6DB33F?style=for-the-badge&logo=spring&logoColor=white"> <img src="https://img.shields.io/badge/springboot-6DB33F?style=for-the-badge&logo=springboot&logoColor=white"> <img src="https://img.shields.io/badge/Spring Security-6DB33F?style=for-the-badge&logo=Spring Security&logoColor=white"><img src="https://img.shields.io/badge/amazonaws-232F3E?style=for-the-badge&logo=amazonaws&logoColor=white"> <img src="https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=Docker&logoColor=white"/> <img src="https://img.shields.io/badge/Redis-DC382D?style=for-the-badge&logo=Redis&logoColor=white"> <img src="https://img.shields.io/badge/nginx-%23009639.svg?style=for-the-badge&logo=nginx&logoColor=white"> <img src="https://img.shields.io/badge/GitHub Actions-2088FF?style=for-the-badge&logo=GitHub Actions&logoColor=white"> <img src="https://img.shields.io/badge/Elasticsearch-005571?style=for-the-badge&logo=Elasticsearch&logoColor=white"> <img src="https://img.shields.io/badge/Logstash-005571?style=for-the-badge&logo=Logstash&logoColor=white"> <img src="https://img.shields.io/badge/Kibana-005571?style=for-the-badge&logo=Kibana&logoColor=white"> <img src="https://img.shields.io/badge/SonarQube-4E9BCD?style=for-the-badge&logo=SonarQube&logoColor=white"> <img src="https://img.shields.io/badge/gradle-02303A?style=for-the-badge&logo=gradle&logoColor=white"> <img src="https://img.shields.io/badge/github-181717?style=for-the-badge&logo=github&logoColor=white"> <img src="https://img.shields.io/badge/Yarn-2C8EBB?style=for-the-badge&logo=Yarn&logoColor=white">

0 commit comments

Comments
 (0)