Skip to content

Commit

Permalink
Docs : 깃헙 리드미 수정
Browse files Browse the repository at this point in the history 
Docs : 깃헙 리드미 수정
  • Loading branch information
@myeongseoklee
myeongseoklee authored Oct 31, 2023
2 parents 5333579 + d5c21a9 commit 7390270
Showing 1 changed file with 165 additions and 52 deletions.
217 changes: 165 additions & 52 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,100 @@
# 🚀 Get Your Feeds 개발과정 🚀
# 🚀 Get Your Feeds 🚀

## 📚 기술 스택

[![NestJS](https://img.shields.io/badge/NestJS-E0234E?style=for-the-badge&logo=nestjs&logoColor=white)](https://nestjs.com/)
[![MongoDB](https://img.shields.io/badge/MongoDB-47A248?style=for-the-badge&logo=mongodb&logoColor=white)](https://www.mongodb.com/)
[![Mongoose](https://img.shields.io/badge/Mongoose-880000?style=for-the-badge&logo=mongoose&logoColor=white)](https://mongoosejs.com/)

### 📁 폴더 구조:
<br>

## 🚀 프로젝트 소개

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

본 레포지토리는 유저 계정의 해시태그(”#dani”) 를 기반으로 `인스타그램`, `스레드`, `페이스북`, `트위터` 등 복수의 SNS에 게시된 게시물 중 유저의 해시태그가 포함된 게시물들을 하나의 서비스에서 확인할 수 있는 통합 Feed 어플리케이션의 Backend API 저장소입니다.

이를 통해 본 서비스의 고객(Client)은 하나의 채널로 유저(”#dani”), 또는 브랜드(”#danishop”) 의 SNS 노출 게시물 및 통계를 확인할 수 있습니다.

<br>

## 🌟 팀원 및 역할 소개

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

<br>

## 🛠️ Document 구조

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

| 필드 | 속성 | 설명 | 예시 값 |
| ----------- | --------------- | ----------------------------------------------------------------------------------------- | --------- |
| content_id | 문자열 | 이는 포스트가 속한 SNS에서 관리하는 고유 인식 값입니다. | |
| type | 문자열 (열거형) | 파일 객체의 유형입니다. 가능한 값은 "facebook", "twitter", "instagram", "threads" 입니다. | "twitter" |
| title | 문자열 | 포스트 제목입니다. | |
| content | 문자열 | 이는 포스트의 내용이며 이미지, 비디오 등을 제외한 텍스트만 포함됩니다. | |
| hashtags | 아무 값 | 여러 개의 해시태그가 있으므로 미래 검색을 고려하여 설계해 주십시오. | |
| view_count | 숫자 | 조회수입니다. | 100 |
| like_count | 숫자 | 좋아요 수입니다. | 10 |
| share_count | 숫자 | 공유 수입니다. | 0 |
| updated_at | 날짜 및 시간 | 포스트를 편집할 때 자동으로 기록됩니다. | |
| created_at | 날짜 및 시간 | 포스트를 생성할 때 자동으로 기록됩니다. | |

<br>

### 2️⃣ 통계(Statistics)

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

<br>

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

| 필드 | 속성 | 설명 | 예시 값 |
|------------------|-------------------------------------------------|------------------------|----------------------------------------------|
| email | `unique: true` | 사용자의 이메일 주소 | "[email protected]" |
| password | | 사용자의 비밀번호 | "SecureP@ssw0rd1" |
| connectedServices| `Array of { service: String, accountTag: String }` | 연결된 소셜 미디어 서비스들 | [{ service: "twitter", accountTag: "@user" }] |


<br>

## 🔥 기능 구현

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

- 게시물 목록 조회 : Feed에 나타나는 게시물 목록 조회 API

- 게시물 상세 조회 : 게시물 목록 클릭 시, 사용되는 게시물 상세 내용 조회 API

- 게시물 좋아요 생성 : 게시물 목록 또는 상세에서 게시물 좋아요 클릭 시 사용되는 API

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

### 2️⃣ 통계(Statistics)

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

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

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

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

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

<br>

## 📁 폴더 구조

<details>
<summary>클릭</summary>
<div>

```
project-root
Expand Down Expand Up @@ -53,53 +141,61 @@ project-root
└── 기타 설정 및 메타데이터 파일들
```

## 📝 API 엔드포인트 상세
</div>
</details>

### 🎉 채용 공고 관리
<br>

# Article Controller API Documentation
## 📝 API 엔드포인트 상세

## Article Operations
### 🎉 게시물(Article)

#### 1. 게시물 목록 조회 : Feed에 나타나는 게시물 목록 조회 API

### 1. Get Paginated Article List
**Endpoint:** `GET /articles`
**Method:** `GET`
**Description:** Fetch a paginated list of articles.
**Query Parameters:** RequestPaginatedQueryDto (pagination parameters)
**Response:** `Page<GetArticleResDto>`

---
<br>

#### 2. 게시물 생성 :

### 2. Create Article
**Endpoint:** `POST /articles`
**Method:** `POST`
**Description:** Create a new article.
**Request Body:** `CreateArticleDto`
**Response:** The content ID of the created article as a string.

---
<br>

#### 3. 게시물 상세 조회 : 게시물 목록 클릭 시, 사용되는 게시물 상세 내용 조회 API

### 3. Send Like by Content ID
**Endpoint:** `GET /articles/likes/:contentId`
**Method:** `GET`
**Description:** Send a like to an article by its content ID.
**Path Parameters:**
- `contentId`: The content ID of the article.
**Response:** The content ID of the liked article as a string.
**Path Parameters:**

---
- `contentId`: The content ID of the article.
**Response:** The content ID of the liked article as a string.

<br>

#### 4. 게시물 좋아요 생성 : 게시물 목록 또는 상세에서 게시물 좋아요 클릭 시 사용되는 API

### 4. Find Article by Content ID
**Endpoint:** `GET /articles/:contentId`
**Method:** `GET`
**Description:** Fetch a specific article using its content ID.
**Path Parameters:**
- `contentId`: The content ID of the article.
**Response:** `GetArticleDetailResDto`
**Path Parameters:**

---
- `contentId`: The content ID of the article.
**Response:** `GetArticleDetailResDto`

<br>

#### 5. 게시물 공유 생성 : 게시물 목록 또는 상세에서 공유하기 클릭 시 사용되는 APIGet Paginated Article List

### 5. Send Share by Content ID
**Endpoint:** `POST /articles/share`
**Method:** `POST`
**Description:** Send a share notification for an article by its content ID.
Expand All @@ -108,71 +204,88 @@ project-root

---

## User Authentication and Registration
## 게시물 통계(Statistics)

### 1. Login
**Endpoint:** `POST /login`
**Method:** `POST`
**Description:** Authenticate and login a user.
**Request Body:** User credentials.
**Response:** HTTP 200 status code with an Authorization header containing the Bearer token.
#### 1. 게시물 통계 데이터 조회 : 해시태그(hashtag)로 검색된 게시물의 시계열 통계 지표(게시물 생성, 조회, 좋아요, 공유 등의 수)를 조회 할 때 사용되는 API

**Endpoint:** `GET /articles`
**Method:** `GET`
**Description:** Retrieve statistics for articles over a specific period.
**Query Parameters:** `GetArticleStatisticsDto`
**Response:** `GetArticleStatisticsResDto`

---

### 2. Register
## 사용자(User)

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

**Endpoint:** `POST /register`
**Method:** `POST`
**Description:** Register a new user.
**Request Body:** `RegisterUserDto`
**Response:** None (void).

---
<br>

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

### 3. Verify User
**Endpoint:** `POST /verify`
**Method:** `POST`
**Description:** Verify a user's email with a code.
**Request Body:**
- `email`: The user's email.
- `code`: The verification code.
**Response:** None (void).
**Request Body:**

---
- `email`: The user's email.
- `code`: The verification code.
**Response:** None (void).

## Article Statistics
<br>

### Get Article Statistics
**Endpoint:** `GET /articles`
**Method:** `GET`
**Description:** Retrieve statistics for articles over a specific period.
**Query Parameters:** `GetArticleStatisticsDto`
**Response:** `GetArticleStatisticsResDto`
#### 3. 사용자 로그인 : 사용자가 계정, 비밀번호로 로그인 시 엑세스 토큰(JWT)을 발급하는 API

---
**Endpoint:** `POST /login`
**Method:** `POST`
**Description:** Authenticate and login a user.
**Request Body:** User credentials.
**Response:** HTTP 200 status code with an Authorization header containing the Bearer token.

<br>

## User Operations

### 1. Create User

**Endpoint:** `POST /`
**Method:** `POST`
**Description:** Create a new user.
**Request Body:**
- `email`: The user's email.
- `password`: The user's password.
- `service`: The service associated with the user.
- `userHashtag`: The user's hashtag.
**Response:** None (void).
**Request Body:**

---
- `email`: The user's email.
- `password`: The user's password.
- `service`: The service associated with the user.
- `userHashtag`: The user's hashtag.
**Response:** None (void).

<br>

### 2. Get User by Email

**Endpoint:** `GET /`
**Method:** `GET`
**Description:** Fetch a user using their email.
**Request Body:** `email` - The user's email.
**Response:** The email of the fetched user as a string.

---

## 🏁 마무리와 배운 점

- NoSQL와 Mongoose를 사용하여 협업하는 경험을 갖을 수 있었습니다.
- NoSQL와 Mongoose를 사용하여 협업하는 경험을 갖을 수 있었습니다.

### 명석

- 좋았던 점 : MongoDB, 통계 관련 API 등 처음 도전하는 기술을 사용해 요구사항을 시간 내에 잘 끝 마칠 수 있었다는 것에 만족한다. 그리고 팀원들과 회의를 하면서 기존에 해오던 방식에서 벗어나 다양한 의견들을 듣고 반영해볼 수 있어서 좋았다.

- 알게된 점 : MongoDB를 사용하는 이유, 장점, NoSQL 모델링 시 유의해야 할 점들에 대해 알게 되었다.

- 개선할 점 : 처음 팀이 구성되고 바로 프로젝트에 들어가다보니 기능 구현을 위한 역할 분담은 되었지만 그외에 많은 것들이 팀장님 어께 위로 얹혀진 것 같아 미안했다 ㅠ. 이제 한 번 프로젝트를 해보았으니 프로젝트를 진행할 때 어떤 역할들이 필요하고 그것들을 각자 잘 분담하면 그 짐을 같이 나눠 짊어질 수 있을 것 같다. 그리고 개인적으로 요구사항 분석을 처음에 제대로 하지 못해, 많은 변경이 생겼다. 처음에는 통계 데이터를 저장할 도큐먼트가 필요 없을 것으로 생각했으나 실제 기능 구현을 위해 요구사항 분석을 해보니 필요했었다. 앞으로 요구사항을 처음에 확실히 분석하고 정리하면 이런 일은 없을 것 같다.

0 comments on commit 7390270

Please sign in to comment.