diff --git a/README.md b/README.md new file mode 100644 index 0000000..907aa45 --- /dev/null +++ b/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) +
+ +YouTube์—๋Š” ์œ ์ตํ•œ ์˜์ƒ๋“ค์ด ์ •๋ง ๋งŽ์Šต๋‹ˆ๋‹ค. ํ•˜์ง€๋งŒ ๊ธด ์˜์ƒ์„ ๋๊นŒ์ง€ ๋ณด๊ธฐ ์–ด๋ ค์šธ ๋•Œ๊ฐ€ ๋งŽ์ฃ . + +'PreView'๋Š” ์˜์ƒ์„ ์ „๋ถ€ ์‹œ์ฒญํ•˜์ง€ ์•Š๊ณ ๋„ ์˜์ƒ ์†์˜ ๋‚ด์šฉ์„ ๋น ๋ฅด๊ฒŒ ์š”์•ฝํ•ฉ๋‹ˆ๋‹ค. + +์š”์•ฝ๋ณธ์€ ์ €์žฅํ•˜์—ฌ ์–ธ์ œ๋“ ์ง€ ๋‹ค์‹œ ํ™•์ธ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. + +**๋ฐ”์œ ํ˜„๋Œ€์ธ๋“ค์„ ์œ„ํ•œ ์œ ํŠœ๋ธŒ ์˜์ƒ ์š”์•ฝ ์„œ๋น„์Šค 'PreView', ์ง€๊ธˆ๋ถ€ํ„ฐ ๋งŒ๋‚˜๋ณด์„ธ์š”!** +
+ +## 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| +|:---:|:---:| +|Frontend| | +|Backend| | +|AI|| +|DevOps| | +|Monitoring| | +|etc| | + +## ๐Ÿ’พ 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)| +