Merge pull request #262 from 2023-Winter-Bootcamp-Team-N/suha0523-pat…

…ch-1

README.md

README.md

@@ -0,0 +1,119 @@
+# 📌 유튜브 영상 실시간 요약 서비스: PreView
+![메인페이지](https://github.com/2023-Winter-Bootcamp-Team-N/2023WB-Team-N/assets/154861396/c8e2f759-3129-4bf0-be7c-561c6226eb75)
+<div align="center">
+
+YouTube에는 유익한 영상들이 정말 많습니다. 하지만 긴 영상을 끝까지 보기 어려울 때가 많죠.     
+
+'PreView'는 영상을 전부 시청하지 않고도 영상 속의 내용을 빠르게 요약합니다.    
+
+요약본은 저장하여 언제든지 다시 확인 수 있습니다.   
+
+**바쁜 현대인들을 위한 유튜브 영상 요약 서비스 'PreView', 지금부터 만나보세요!**
+</div>
+
+## Table of Contents
+* [Medium](#-medium)
+* [Demo Video](#-demo-video)
+* [System Architechture](#-system-architechture)
+* [Tech Stack](#-tech-stack)
+* [ERD](#-erd)
+* [API](#-api)
+* [Monitoring](#-monitoring)
+* [How to start](#-how-to-start)
+* [Team Members](#-team-members)
+
+## ✨ Medium
+[[2023 Winter Silicon Valley BootCamp] preview](https://medium.com/@wndjs803/2023-winter-silicon-valley-bootcamp-preview-16a19066ddb5)
+
+## 📹 Demo Video
+### 영상 요약
+![영상요약](https://github.com/2023-Winter-Bootcamp-Team-N/2023WB-Team-N/assets/154861396/7138dce1-e181-4c0e-85e3-5d4f9bb81637)
+
+### 구독 채널 페이지
+![구독페이지](https://github.com/2023-Winter-Bootcamp-Team-N/2023WB-Team-N/assets/154861396/3b0e74ba-38f2-4252-ba94-10224737c07c)
+
+### 시간대별 요약
+![시간대별요약](https://github.com/2023-Winter-Bootcamp-Team-N/2023WB-Team-N/assets/154861396/82cdd29e-ad97-45dc-a2a9-9373dfd9fbda)
+
+### 카테고리 차트
+![카테고리차트](https://github.com/2023-Winter-Bootcamp-Team-N/2023WB-Team-N/assets/154861396/c36d2b1d-0644-49fc-bf7b-9459cad74646)
+
+### 채널별 차트
+![채널별 차트](https://github.com/2023-Winter-Bootcamp-Team-N/2023WB-Team-N/assets/154861396/c1adf2f5-bee9-400e-8608-187d9d4a8978)
+
+## 🐋 System Architechture
+![System Architechture](https://github.com/2023-Winter-Bootcamp-Team-N/2023WB-Team-N/assets/154861396/19d93e54-01c3-4c8b-86db-c804a3d38734)
+
+## 💡 Tech Stack
+|Area|Tech Stack|
+|:---:|:---:|
+|<b>Frontend</b>|<img src="https://img.shields.io/badge/react-61DAFB?style=for-the-badge&logo=react&logoColor=black"> <img src="https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white"> <img src="https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white"> <img src="https://img.shields.io/badge/Tailwind CSS-06B6D4?style=for-the-badge&logo=Tailwind CSS&logoColor=white"> <img src="https://img.shields.io/badge/ESLint-4B32C3?style=for-the-badge&logo=ESLint&logoColor=white"> <img src="https://img.shields.io/badge/Prettier-FFCC00?style=for-the-badge&logo=prettier&logoColor=white">|
+|<b>Backend</b>|<img src="https://img.shields.io/badge/django-%23092E20.svg?style=for-the-badge&logo=django&logoColor=white"> <img src="https://img.shields.io/badge/DJANGO-REST-ff1709?style=for-the-badge&logo=django&logoColor=white&color=ff1709&labelColor=gray"> <img src="https://img.shields.io/badge/Amazon%20S3-569A31?style=for-the-badge&logo=Amazon%20S3&logoColor=white"> <img src="https://img.shields.io/badge/postgresql-%23316192.svg?style=for-the-badge&logo=postgresql&logoColor=white"> <img src="https://img.shields.io/badge/Rabbitmq-FF6600?style=for-the-badge&logo=rabbitmq&logoColor=white"> <img src="https://img.shields.io/badge/celery-%23a9cc54.svg?style=for-the-badge&logo=celery&logoColor=ddf4a4">|
+|<b>AI</b>|<img src="https://img.shields.io/badge/chatGPT-74aa9c?style=for-the-badge&logo=openai&logoColor=white">|
+|<b>DevOps</b>|<img src="https://img.shields.io/badge/docker-2496ED?style=for-the-badge&logo=docker&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/Amazon_AWS-FF9900?style=for-the-badge&logo=amazonaws&logoColor=white"> <img src="https://img.shields.io/badge/Github Actions-2088FF?style=for-the-badge&logo=Github Actions&logoColor=white">|
+|<b>Monitoring</b>|<img src="https://img.shields.io/badge/Prometheus-E6522C?style=for-the-badge&logo=Prometheus&logoColor=white"> <img src="https://img.shields.io/badge/grafana-%23F46800.svg?style=for-the-badge&logo=grafana&logoColor=white"> <img src="https://img.shields.io/badge/elastic stack-005571?style=for-the-badge&logo=elasticstack&logoColor=white"> <img src="https://img.shields.io/badge/cadvisor-2196F3?style=for-the-badge&logo=cadvisor&logoColor=white"> <img src="https://img.shields.io/badge/Node Exporter-4CAF50?style=for-the-badge&logo=Node Exporter&logoColor=white">|
+|<b>etc</b>|<img src="https://img.shields.io/badge/github-181717?style=for-the-badge&logo=github&logoColor=white"> <img src="https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white"> <img src="https://img.shields.io/badge/Notion-000000?style=for-the-badge&logo=notion&logoColor=white"> <img src="https://img.shields.io/badge/Postman-FF6C37?style=for-the-badge&logo=postman&logoColor=white"> <img src="https://img.shields.io/badge/-Swagger-%23Clojure?style=for-the-badge&logo=swagger&logoColor=white"> <img src="https://img.shields.io/badge/figma-%23F24E1E.svg?style=for-the-badge&logo=figma&logoColor=white"> <img src="https://img.shields.io/badge/Visual%20Studio%20Code-0078d7.svg?style=for-the-badge&logo=visual-studio-code&logoColor=white">|
+
+## 💾 ERD
+![ERD](https://github.com/2023-Winter-Bootcamp-Team-N/2023WB-Team-N/assets/154861396/6543243b-eca0-4feb-a1ba-abd8b3f73f82)
+
+## 🔑 API
+![API1](https://github.com/2023-Winter-Bootcamp-Team-N/2023WB-Team-N/assets/154861396/a7b471fa-29d3-4936-864b-9d184bd395a5) ![API2](https://github.com/2023-Winter-Bootcamp-Team-N/2023WB-Team-N/assets/154861396/01d26133-59ff-4c50-90b4-9c12a191e4e4)
+
+## 💻 Monitoring
+### Prometheus & Grafana
+#### 1. Django
+![Django](https://github.com/2023-Winter-Bootcamp-Team-N/2023WB-Team-N/assets/154861396/bb11b8ce-a8df-4a04-83c6-cc014c3152cd)
+* Django에서 Prometheus를 통해 request,response에 대한 정보를 수집을 한 후 Grafana를 통해 시각화
+
+#### 2. Node Exporter
+![Node Exporter](https://github.com/2023-Winter-Bootcamp-Team-N/2023WB-Team-N/assets/154861396/8b3d8812-fde3-47f1-9043-3b6839f0bf55)
+* Node Exporter를 통해 서버의 메모리, CPU 사용량, Network Traffic 등을 모니터링
+
+### cAdvisor
+![cAdvisor](https://github.com/2023-Winter-Bootcamp-Team-N/2023WB-Team-N/assets/154861396/f4bcb112-6909-45d5-a468-cc98d346c4fd)
+* cAdvisor를 활용해 각 컨테이너의 CPU, Memory 사용량, Network 사용량 등을 모니터링
+
+### ELK
+![ELK](https://github.com/2023-Winter-Bootcamp-Team-N/2023WB-Team-N/assets/154861396/6c9059aa-0c22-446f-b627-826dff7dd194)
+* ELK Stack을 활용하여 시스템 전반의 성능과 안정성을 모니터링
+
+## 🚀 How to start
+#### 준비물(비용이 발생할 수 있음)
+* [OpenAI API key 발급받기](https://platform.openai.com/)
+* [YouTube API key 발급받기](https://console.cloud.google.com/apis/library/youtube.googleapis.com?hl=ko&project=nifty-inn-410713)
+* [AWS S3 Bucket 만들기](https://aws.amazon.com/ko/s3/getting-started/)
+#### 1. Clone The Repository
+```
+https://github.com/2023-Winter-Bootcamp-Team-N/2023WB-Team-N.git
+```
+#### 2. ENV Setting
+* /.env (docker-compose.yml 파일과 같은 디렉토리에 생성)
+* YouTube API key는 DEVELOPER_KEY1, DEVELOPER_KEY2 중 하나에만 넣어도 무관
+```
+POSTGRES_DB=postgres
+POSTGRES_USER=
+POSTGRES_PASSWORD=
+
+SECRET_KEY=""
+OPENAI_API_KEY=""
+DEVELOPER_KEY1=""
+DEVELOPER_KEY2=""
+
+AWS_ACCESS_KEY_ID = ""
+AWS_SECRET_ACCESS_KEY = ""
+# S3 버킷 및 파일 저장 경로 설정
+AWS_STORAGE_BUCKET_NAME = ""
+```
+#### 3. Run Docker
+```
+docker-compose up --d
+```
+
+## 👥 Team Members
+|Name|박세종|김주언|신수진|한승철|최지혜|최수하|
+|---|---|---|---|---|---|---|
+|Profile|![박세종](https://github.com/sejongpark.png)|![김주언](https://github.com/wndjs803.png)|![신수진](https://github.com/Shin-Sujin.png)|![한승철](https://github.com/HSCEHOL.png)|![최지혜](https://github.com/jihye1006.png)|![최수하](https://github.com/suha0523.png)|
+|Role|Leader, Frontend, DevOps|Backend, DevOps|Frontend|Frontend|Backend, DevOps|Backend, DevOps|
+|GitHub|[@sejongpark](https://github.com/sejongpark)|[@wndjs803](https://github.com/wndjs803)|[@Shin-Sujin](https://github.com/Shin-Sujin)|[@HSCEHOL](https://github.com/HSCEHOL)|[@jihye1006](https://github.com/jihye1006)|[@suha0523](https://github.com/suha0523)|
+