Skip to content

Commit

Permalink
Docs : Readme 기본 디자인 추가
Browse files Browse the repository at this point in the history
  • Loading branch information
myeongseoklee committed Oct 31, 2023
1 parent 834b633 commit 15c573b
Showing 1 changed file with 23 additions and 18 deletions.
41 changes: 23 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<br>

## 프로젝트 소개
## 🚀 프로젝트 소개

Get Your Feeds는 소셜 미디어 통합 Feed 서비스입니다.

Expand All @@ -18,17 +18,17 @@ Get Your Feeds는 소셜 미디어 통합 Feed 서비스입니다.

<br>

## 팀원 및 역할 소개
## 🌟 팀원 및 역할 소개

| 고미종 | 추연규 | 이명석 | 송호준 | 이상운 |
| :-------------------------------: | :---------------------------------: | :--------------: | :-----------: | :----------------: |
| 게시물 상세 조회 <br> 게시물 공유 | 게시물 목록 조회 <br> 게시물 좋아요 | 게시물 통계 조회 | jwt 토큰 인증 | 유저 비즈니스 로직 |

<br>

## Document 구조
## 🛠️ Document 구조

### 게시글(Article)
### 1️⃣ 게시글(Article)

| 필드 | 속성 | 설명 | 예시 값 |
| ----------- | --------------- | ----------------------------------------------------------------------------------------- | --------- |
Expand All @@ -45,40 +45,45 @@ Get Your Feeds는 소셜 미디어 통합 Feed 서비스입니다.

<br>

### 통계(Statistics)
### 2️⃣ 통계(Statistics)

| 필드 | 속성 | 설명 | 예시 값 |
| ---- | ---- | ---- | ------- |
| | | | |

<br>

### 사용자(User)
### 3️⃣ 사용자(User)

| 필드 | 속성 | 설명 | 예시 값 |
| ---- | ---- | ---- | ------- |
| | | | |

<br>

## 기능 구현
## 🔥 기능 구현

### 게시글(Article)
### 1️⃣ 게시글(Article)

1. 게시물 목록 조회 : Feed에 나타나는 게시물 목록 조회 API
2. 게시물 상세 조회 : 게시물 목록 클릭 시, 사용되는 게시물 상세 내용 조회 API
3. 게시물 좋아요 생성 : 게시물 목록 또는 상세에서 게시물 좋아요 클릭 시 사용되는 API
4. 게시물 공유 생성 : 게시물 목록 또는 상세에서 공유하기 클릭 시 사용되는 API
- 게시물 목록 조회 : Feed에 나타나는 게시물 목록 조회 API

### 통계(Statistics)
- 게시물 상세 조회 : 게시물 목록 클릭 시, 사용되는 게시물 상세 내용 조회 API

1. 게시물 통계 데이터 조회 : 해시태그(hashtag)로 검색된 게시물의 시계열 통계 지표(게시물 생성, 조회, 좋아요, 공유 등의 수)를 조회 할 때 사용되는 API
- 게시물 좋아요 생성 : 게시물 목록 또는 상세에서 게시물 좋아요 클릭 시 사용되는 API

### 사용자(User)
- 게시물 공유 생성 : 게시물 목록 또는 상세에서 공유하기 클릭 시 사용되는 API

1. 사용자 회원가입 요청 : 사용자 회원가입 요청에 사용되는 API. 회원가입 요청 이후 6자리의 랜덤한 코드가 입력한 이메일로 발송됩니다.
2. 사용자 가입 승인 : 사용자 회원 가입 요청을 승인하는 API. 회원 가입 요청자의 이메일로 전송된 코드와 사용자 정보를 검증하여 가입 승인 처리합니다.
3. 사용자 로그인 : 사용자가 계정, 비밀번호로 로그인 시 엑세스 토큰(JWT)을 발급하는 API
### 2️⃣ 통계(Statistics)

- 게시물 통계 데이터 조회 : 해시태그(hashtag)로 검색된 게시물의 시계열 통계 지표(게시물 생성, 조회, 좋아요, 공유 등의 수)를 조회 할 때 사용되는 API

### 3️⃣ 사용자(User)

- 사용자 회원가입 요청 : 사용자 회원가입 요청에 사용되는 API. 회원가입 요청 이후 6자리의 랜덤한 코드가 입력한 이메일로 발송됩니다.

- 사용자 가입 승인 : 사용자 회원 가입 요청을 승인하는 API. 회원 가입 요청자의 이메일로 전송된 코드와 사용자 정보를 검증하여 가입 승인 처리합니다.

- 사용자 로그인 : 사용자가 계정, 비밀번호로 로그인 시 엑세스 토큰(JWT)을 발급하는 API

<br>

Expand Down

0 comments on commit 15c573b

Please sign in to comment.