https://github.com/f-lab-edu/pub-sub
팬과 크리에이터들을 위한 월정액 멤버십 플랫폼
https://github.com/f-lab-edu/pub-sub
docker jpa-hibernate mysql spring-boot
Last synced: 2 months ago
JSON representation
팬과 크리에이터들을 위한 월정액 멤버십 플랫폼
- Host: GitHub
- URL: https://github.com/f-lab-edu/pub-sub
- Owner: f-lab-edu
- License: mit
- Created: 2024-03-13T14:53:47.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-04T09:58:10.000Z (about 1 year ago)
- Last Synced: 2025-04-23T01:12:42.489Z (2 months ago)
- Topics: docker, jpa-hibernate, mysql, spring-boot
- Language: Java
- Homepage:
- Size: 313 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
- [프로젝트 소개](#pub-sub)
- [ERD](#ERD)
- [API 명세](#API-명세)
- [브랜치 전략](#브랜치-전략)
# pub-sub
팬과 크리에이터들을 위한 월정액 기반 멤버십 플랫폼
## [ERD](https://www.erdcloud.com/d/brDjdwe2aGKvc33gu)
## API 명세
### 로그인/회원가입
| | 메서드 | Endpoint |
| --- | --- | --- |
| 로그인 | POST | /login |
| 로그아웃 | POST | /logout |
| 회원가입 | POST | /signup |
### 유저
| | 메서드 | Endpoint |
| --- | --- | --- |
| 프로필 조회 | GET | /{nickname} |
| 프로필 수정 | PATCH | /accounts/edit |
| 회원탈퇴 | DELETE | /accounts/delete |
| 구독중인 멤버십 조회 | GET | /accounts/subscriptions |
### 멤버십
| | 메서드 | Endpoint |
| --- | --- | --- |
| 멤버십 생성 | POST | /subscriptions |
| 멤버십 구독 | POST | /subscriptions/subscribe |
| 멤버십 취소 | POST | /subscriptions/unsubscribe |
### 게시물
| | 메서드 | Endpoint |
| --- | --- | --- |
| Public 게시물 조회 | GET | / |
| 구독중인 private 게시물 조회 | GET | /subscribed |
| 게시물 작성 | POST | /posts |
| 특정 게시물 조회 | GET | /posts/{postId} |
| 게시물 수정 | PATCH | /posts/{postId} |
| 게시물 삭제 | DELETE | /posts/{postId} |
| 게시물 좋아요 | POST | /likes/like |
| 게시물 좋아요 취소 | POST | /likes/remove-like |
### 댓글
| | 메서드 | Endpoint |
| --- | --- | --- |
| 댓글 작성 | POST | /comments |
| 댓글 수정 | PUT | /comments/{commentId} |
| 댓글 삭제 | DELETE | /comments/{commentId} |
## 브랜치 전략
GitHub-Flow 기반
| 브랜치명 | 구분 | 설명 |
| --- | --- | --- |
| `main` | 메인 | 배포를 위한 브랜치 |
| `feat` | 보조 | 기능 단위 개발 브랜치 |
| `fix` | 보조 | 오류 해결을 위한 브랜치 |
| `docs` | 보조 | 문서 작업을 위한 브랜치 |
| `refactor` | 보조 | 리팩토링을 위한 브랜치 |
| `chore` | 보조 | 기타 작업을 위한 브랜치 |