Merge pull request #131 from Quickchive/release/0.1.0

Release/0.1.0

.github/workflows/ci-cd-for-test.yml

@@ -0,0 +1,41 @@
+name: Docker Image CI && Deploy to EC2 for Test Server
+
+on:
+  push:
+    branches: ['release/**']
+
+jobs:
+  job1:
+    name: Docker Image CI
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Login to DockerHub
+        uses: docker/[email protected]
+        with:
+          username: ${{secrets.DOCKERHUB_USERNAME}}
+          password: ${{secrets.DOCKERHUB_TOKEN}}
+
+      - name: Build and push Docker images
+        uses: docker/[email protected]
+        with:
+          context: .
+          tags: hou27/test_quickchive_backend:latest
+          push: true
+  job2:
+    needs: job1
+    name: Deploy to EC2
+    runs-on: quickchive-server
+
+    steps:
+      - name: executing remote ssh commands using password
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ secrets.HOST }}
+          username: ubuntu
+          key: ${{ secrets.KEY_PAIR }}
+          script: |
+            sh /home/ubuntu/actions-runner/deploy_test_server.sh

.github/workflows/ci-cd.yml

@@ -2,7 +2,7 @@ name: Docker Image CI && Deploy to EC2
 
 on:
   push:
-    branches: ['develop']
+    branches: ['master']
   # pull_request:
   #   branches: ['develop']
 

Dockerfile

@@ -3,6 +3,7 @@ FROM node:16.13.1-alpine3.15 AS builder
 ## make work directory and copy files
 WORKDIR /app
 COPY . .
+
 ## project dependency install
 RUN rm -rf dist && npm install
 RUN npm run build
@@ -11,5 +12,10 @@ FROM node:16.13.1-alpine3.15
 WORKDIR /usr/src/app
 COPY --from=builder /app ./
 
+# Timezone setting
+
+## install tzdata package for timezone setting
+RUN apk add tzdata && ln -snf /usr/share/zoneinfo/Asia/Seoul /etc/localtime
+
 EXPOSE 4000
 CMD npm run start:prod

README.md

@@ -1,57 +1,110 @@
 # Quickchive Backend
 
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/quickchive/quickchive-backend?style=flat-square)
+![deploy](https://github.com/Quickchive/quickchive-backend/actions/workflows/ci-cd.yml/badge.svg)
+
 ## Description
 
-> Quickchive 서비스의 Backend Repository입니다.
+[Quickchive](https://quickchive.swygbro.com/)  
+[Quickchive Frontend](https://github.com/Quickchive/Quickchive-frontend)
+
+# v0.1.0
+
+> releated with quickchive version 1.0
+
+<br/>
+
+## :open_file_folder: 프로젝트 개요
+
+- 읽어둬야 할 아티클 링크, 참석해야 하는 세미나 링크, 봐둬야 할 영상링크 등 자기개발을 위해 읽어두고 알아야 할 링크를 분류해서 저장할 수 있는 북마크 서비스입니다.
+
+<br/>
+
+## :people_holding_hands: 대상
+
+- 여러가지 이유로 여러 곳에서 다시 볼 목적으로 콘텐츠를 수집하는 사람들
+
+<br/>
+
+## :cloud: 기획 배경
+
+### 마주한 문제
+
+1. **저장해둔 북마크를 다시 읽지 않는 사람들**: 까먹거나, 귀찮아서, 여러 플랫폼에 좋아요/저장/스크랩형태로 읽을 거리를 여기저기 널려놨기 때문에 관리가 힘들어 다시 보지 않습니다.
+
+2. **기존 북마크 서비스를 사용하지 않는 사람들**: 기본 메모앱을 사용하거나, 스크린샷 혹은 카카오톡 나에게 보내기를 사용한다. 이로 인해 저장해둔 북마크를 다시 읽지 않는다는 1번 문제가 다시 발생합니다.
+
+3. **북마크해뒀던 아티클을 읽을 때 부담되는 사람들**: 읽을 거리가 많아서 부담된거나, 영어라서 부담되는 등의 이유로 읽지 않는 사람들도 있습니다.
 
-<br>
-<p align="center">
-  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo_text.svg" width="320" alt="Nest Logo" /></a>
-</p>
+위와 같은 문제들 탓에 항상 읽어야지 하고 다짐만 하고, 저장한 아티클만 쌓여가는 분들을 위해  
+보다 편리하고 빠르게 아티클들을 관리하고 볼 수 있도록 돕고자 기획하게 되었습니다.
 
-[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
-[circleci-url]: https://circleci.com/gh/nestjs/nest
+<br/>
+<br/>
 
-  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
-    <p align="center">
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
+# :computer: API 구조
 
-## Installation
+### User API
 
-```bash
-$ npm install
-```
+| URL                         | method | Usage                | Authorization Needed |
+| --------------------------- | ------ | -------------------- | -------------------- |
+| /api/users/edit             | POST   | 프로필 수정          | O                    |
+| /api/users/reset-password   | POST   | 비밀번호 재생성      | X                    |
+| /api/users/me               | GET    | 프로필 조회          | O                    |
+| /api/users/load-contents    | GET    | 유저의 콘텐츠 조회   | O                    |
+| /api/users/load-favorites   | GET    | 유저의 즐겨찾기 조회 | O                    |
+| /api/users/load-collections | GET    | 유저의 콜렉션 조회   | O                    |
+| /api/users/load-categories  | GET    | 유저의 카테고리 조회 | O                    |
 
-## Running the app
+### Auth API
 
-```bash
-# development
-$ npm run start
+| URL                                               | method | Usage                            | Authorization Needed |
+| ------------------------------------------------- | ------ | -------------------------------- | -------------------- |
+| /api/auth/register                                | POST   | 회원가입                         | X                    |
+| /api/auth/login                                   | POST   | 이메일 로그인                    | X                    |
+| /api/auth/logout                                  | POST   | 로그아웃                         | O                    |
+| /api/auth/reissue                                 | POST   | 토큰 재발행                      | X                    |
+| /api/auth/send-verify-email/\<str:email\>         | GET    | 유저 인증을 위한 메일 전송       | X                    |
+| /api/auth/send-password-reset-email/\<str:email\> | GET    | 비밀번호 재설정을 위한 메일 전송 | X                    |
+| /api/auth/verify-email                            | GET    | 이메일 인증                      | X                    |
 
-# watch mode
-$ npm run start:dev
+### OAuth API
 
-# production mode
-$ npm run start:prod
-```
+| URL                     | method | Usage                   | Authorization Needed |
+| ----------------------- | ------ | ----------------------- | -------------------- |
+| /api/oauth/kakao-auth   | GET    | 카카오 계정 로그인 요청 | X                    |
+| /api/oauth/kakao-login  | GET    | 카카오 로그인           | X                    |
+| /api/oauth/google-auth  | GET    | 구글 계정 로그인 요청   | X                    |
+| /api/oauth/google-login | GET    | 구글 로그인             | X                    |
 
-## Test
+### Content API
 
-```bash
-# unit tests
-$ npm run test
+| URL                                      | method | Usage                 | Authorization Needed |
+| ---------------------------------------- | ------ | --------------------- | -------------------- |
+| /api/contents/add                        | POST   | 콘텐츠 추가           | O                    |
+| /api/contents/addMultiple                | POST   | 다수의 콘텐츠 추가    | O                    |
+| /api/contents/update                     | POST   | 콘텐츠 정보 수정      | O                    |
+| /api/contents/favorite/\<int:contentId>  | PATCH  | 즐겨찾기 등록 및 해제 | O                    |
+| /api/contents/read/\<int:contentId>      | PATCH  | 읽었음 표시           | O                    |
+| /api/contents/delete/\<int:contentId>    | DELETE | 콘텐츠 삭제           | O                    |
+| /api/contents/summarize/\<int:contentId> | GET    | 콘텐츠 문서 요약      | O                    |
 
-# e2e tests
-$ npm run test:e2e
+### Category API
 
-# test coverage
-$ npm run test:cov
-```
+| URL                                    | method | Usage         | Authorization Needed |
+| -------------------------------------- | ------ | ------------- | -------------------- |
+| /api/category/add                      | POST   | 카테고리 추가 | O                    |
+| /api/category/update                   | POST   | 카테고리 수정 | O                    |
+| /api/category/delete/\<int:categoryId> | DELETE | 카테고리 삭제 | O                    |
 
-## Support
+### Collection API
 
-Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+| URL                                           | method | Usage                 | Authorization Needed |
+| --------------------------------------------- | ------ | --------------------- | -------------------- |
+| /api/collections/add                          | POST   | 콜렉션 추가           | O                    |
+| /api/collections/update                       | POST   | 콜렉션 수정           | O                    |
+| /api/collections/favorite/\<int:collectionId> | PATCH  | 즐겨찾기 등록 및 해제 | O                    |
+| /api/collections/delete/\<int:contentId>      | DELETE | 콜렉션 삭제           | O                    |
 
 ## License
 

Wiki/CI_CD.md

@@ -59,16 +59,17 @@ steps:
 
 > ec2 인스턴스 내에 스크립트 파일 생성  
 > 이전 버전의 docker container와 docker image를 삭제한 후 docker hub에 job1을 통해 업로드한 image를 pull하여  
-> 해당 이미지를 사용하여 다시 ec2 인스턴스에서 docker compose 컨테이너를 실성 및 실행한다.
+> 해당 이미지를 사용하여 다시 ec2 인스턴스에서 docker 컨테이너를 생성 및 실행한다.
 
 ```sh
 # !/bin/bash
-docker ps -a | grep quickchive_backend:latest | awk '{print$1}' | xargs -t -I % docker rm -f % && docker image ls | grep quickchive | awk '{print$3}' | xargs -I % docker rmi %
-cd ~ubuntu && docker-compose up -d
+docker ps -a | grep hou27/quickchive_backend | awk '{print$1}' | xargs -t -I % docker rm -f % && docker image ls | grep hou27/quickchive_backend | awk '{print$3}' | xargs -I % docker rmi %
+docker pull hou27/quickchive_backend
+cd ~ubuntu && docker run -d --name api-server -p 80:4000 --network ubuntu_shared-network -e NODE_ENV=prod --env-file .env.prod hou27/quickchive_backend
 ```
 
 - 기존 컨테이너 삭제, 이미지 삭제 후
-  docker-compose up 실행
+  docker container 실행
 
 # 전체 github action workflow를 정의한 파일
 
@@ -118,3 +119,59 @@ jobs:
           script: |
             sh /home/ubuntu/actions-runner/deploy.sh
 ```
+
+## ci-cd-for-test.yml
+
+```yaml
+name: Docker Image CI && Deploy to EC2 for Test Server
+
+on:
+  push:
+    branches: ['release/**']
+
+jobs:
+  job1:
+    name: Docker Image CI
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Login to DockerHub
+        uses: docker/[email protected]
+        with:
+          username: ${{secrets.DOCKERHUB_USERNAME}}
+          password: ${{secrets.DOCKERHUB_TOKEN}}
+
+      - name: Build and push Docker images
+        uses: docker/[email protected]
+        with:
+          context: .
+          tags: hou27/test_quickchive_backend:latest
+          push: true
+  job2:
+    needs: job1
+    name: Deploy to EC2
+    runs-on: quickchive-server
+
+    steps:
+      - name: executing remote ssh commands using password
+        uses: appleboy/ssh-action@master
+        with:
+          host: ${{ secrets.HOST }}
+          username: ubuntu
+          key: ${{ secrets.KEY_PAIR }}
+          script: |
+            sh /home/ubuntu/actions-runner/deploy_test_server.sh
+```
+
+> deploy.sh는 배포 서버용이었다면,
+> deploy_test_server.sh는 테스트 서버용.
+
+```sh
+# !/bin/bash
+docker ps -a | grep test-api-server | awk '{print$1}' | xargs -t -I % docker rm -f % && docker image ls | grep test_quickchive | awk '{print$3}' | xargs -I % docker rmi %
+docker pull hou27/test_quickchive_backend
+cd ~ubuntu && docker run -d --name test-api-server -p 3000:4000 --network ubuntu_shared-network -e NODE_ENV=test --env-file .env.test hou27/test_quickchive_backend
+```

Wiki/Docker-Compose.md

@@ -43,3 +43,45 @@ networks:
 ```
 
 > api + redis + postgresql
+
+<br>
+
+### 배포 서버와 테스트 서버를 하나의 ec2 내에 구축한 후의 docker-compose 파일
+
+- api server를 제외한 나머지 둘만 올리도록 함.
+
+```yaml
+version: '2'
+
+services:
+  redis: # Name of container
+    image: redis:latest
+    restart: always
+    ports:
+      - 6379:6379
+    networks:
+      - shared-network
+  postgres: # Name of container
+    image: postgres:alpine
+    restart: always
+    env_file:
+      - .env.prod
+    environment:
+      POSTGRES_HOST_AUTH_METHOD: 'trust'
+    ports:
+      - 5432:5432
+    networks:
+      - shared-network
+networks:
+  shared-network:
+    driver: bridge
+```
+
+api server를 이 docker compose 파일로 올린 redis, postgreSQL 서버와 연결하기 위해선  
+실행 시 network에 연결해주어야 한다.
+
+ex)
+
+```sh
+docker run -d --name test-api-server -p 3000:4000 --network [docker compose 파일로 생성된 네트워크] --env-file .env.prod hou27/quickchive_backend
+```

Wiki/ENV.md

@@ -14,6 +14,7 @@ DB_PORT=
 POSTGRES_DB=
 POSTGRES_USER=
 POSTGRES_PASSWORD=
+POSTGRES_DB_NAME=
 KAKAO_REST_API_KEY=
 KAKAO_REDIRECT_URI_LOGIN=
 KAKAO_CLIENT_SECRET=

Wiki/HISTORY.md

@@ -0,0 +1,42 @@
+# HISTORY
+
+# v0.1.0
+
+## 🚀 Added
+
+> MVP
+
+1. User
+
+- 로그인: OAuth(구글로그인, 카카오로그인), 이메일 로그인(자체 로그인 기능)
+- 자동로그인 정책: 한달 동안 접속하지 않아도 로그인 유지 - refresh token 활용(만료 기간 한달)
+- 회원가입(이메일 인증방식)
+  - 회원가입 시 받는 정보: 이메일(메일로 인증필수), 닉네임, 비밀번호(8자 이상 문자, 숫자)
+- 닉네임 수정
+- 비밀번호 재설정
+- 로그아웃
+- 회원 탈퇴
+
+2. Content
+
+- 저장: 콘텐츠 이름, \*URL, 메모, 카테고리, 즐겨찾기, 읽을 기한
+- 삭제
+- 수정: 콘텐츠 이름, 메모, 카테고리, 즐겨찾기, 읽을 기한
+
+3. Collection
+
+- 저장: \*콜렉션 이름, 콜렉션 설명, URL, 카테고리, 즐겨찾기
+- 삭제
+- 수정: 콘텐츠 이름, URL(추가, 삭제, 순서 변경), 카테고리, 읽을 기한
+
+4. 알림
+
+- 읽을 기한 알림: 매일 08:00 KST에 읽을 기한 만료된 콘텐츠에 대한 메일 알림 전송
+
+## 📝 Changed
+
+None
+
+## :no_entry_sign: Removed
+
+None