Feedback

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,18 @@
+---
+name: Bug report
+about: 버그 발생 시 사용하는 템플릿
+title: "[BUG] "
+labels: ''
+assignees: ''
+
+---
+
+## Description
+
+## How to reproduce
+
+1.
+2.
+3.
+
+## Solution

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: 새로운 기능을 추가할 때 사용하는 템플릿
+title: "[FEAT] "
+labels: ''
+assignees: ''
+
+---
+
+## Background
+-
+
+## To do
+- [ ]

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+## Overview
+-
+
+## Change Log
+-
+
+## To Reviewer
+-
+
+## Issue Tags
+- Closed | Fixed: # 
+- See also: #

.gitignore

@@ -0,0 +1,213 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python,visualstudiocode,linux
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,visualstudiocode,linux
+
+### log
+log/
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+# End of https://www.toptal.com/developers/gitignore/api/python,visualstudiocode,linux

README.md

@@ -0,0 +1,104 @@
+# 프로젝트 소개
+“나만의 장바구니” 는 사용자의 요리 이력을 기반으로 다음에 요리할 레시피와 해당 레시피를 만드는 데 필요한 재료 목록을 추천하는 서비스 입니다.
+
+## preview
+https://github.com/boostcampaitech6/level2-3-recsys-finalproject-recsys-01/assets/35794681/a516edbe-058b-41f4-8942-135fe476edb4
+
+# 진행 기간
+2024.02.28 ~ 2024.03.27
+
+# 멤버
+<table align="center">
+  <tr height="205px">
+    <td align="center" width="200px">
+      <a href="https://github.com/sangwoonoel"><img src="https://github.com/sangwoonoel.png" width="150px;" alt=""/></a>
+    </td>
+    <td align="center" width="200px">
+      <a href="https://github.com/twndus"><img src="https://github.com/twndus.png" width="150px;" alt=""/></a>
+    </td>
+    <td align="center" width="200px">
+      <a href="https://github.com/uhhyunjoo"><img src="https://github.com/uhhyunjoo.png" width="150px;" alt=""/></a>
+    </td>
+    <td align="center" width="200px">
+      <a href="https://github.com/GangBean"><img src="https://github.com/GangBean.png" width="150px;" alt=""/></a>
+    </td>
+  </tr>
+  <tr>
+    <td align="center" width="200px">
+      <a href="https://github.com/sangwoonoel">신상우</a>
+    </td>
+    <td align="center" width="200px">
+      <a href="https://github.com/twndus">이주연</a>
+    </td>
+    <td align="center" width="200px">
+      <a href="https://github.com/uhhyunjoo">이현주</a>
+    </td>
+    <td align="center" width="200px">
+      <a href="https://github.com/GangBean">조성홍</a>
+    </td>
+  </tr>
+  <tr>
+    <td width="200px">
+      <br>
+      • 레시피 서비스 기능 API 구현 <br>
+      • 데이터 정제 <br>
+      • ML modeling <br>
+      • MLflow를 이용한 ML 라이플 사이클 관리 <br>
+    </td>
+    <td width="200px">
+      <br>
+      • 프론트엔드 구현 <br>
+      • 최적화 알고리즘 설계 <br>
+      • 데이터 크롤링 <br>
+      • ML modeling & serving <br>
+    </td>
+    <td width="200px">
+      <br>
+      • 프론트엔드 구현 <br>
+      • 데이터 크롤링 및 전처리 <br>
+      • DB 업데이트 자동화 <br>
+    </td>
+    <td width="200px">
+      <br> 
+      • 유저 서비스 기능 API 구현 <br>
+      • 장바구니 추천 API 구현 <br>
+      • 데이터 수집 <br>
+      • 데이터베이스 설정 <br>
+    </td>
+  </tr>
+</table>
+&nbsp;
+
+# 사용 기술
+![Streamlit](https://img.shields.io/badge/streamlit%20-%23FF0000.svg?style=for-the-badge&logo=streamlit&logoColor=white)
+![FastAPI](https://img.shields.io/badge/FastAPI-005571?style=for-the-badge&logo=fastapi)
+![Apache Airflow](https://img.shields.io/badge/Apache%20Airflow-017CEE?style=for-the-badge&logo=Apache%20Airflow&logoColor=white)
+![mlflow](https://img.shields.io/badge/mlflow-%23d9ead3.svg?style=for-the-badge&logo=numpy&logoColor=blue)
+![Selenium](https://img.shields.io/badge/-selenium-%43B02A?style=for-the-badge&logo=selenium&logoColor=white)
+![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white)
+![Recbole](https://img.shields.io/badge/Recbole-f54d2d)
+
+# 서비스 아키텍처
+![image](https://github.com/boostcampaitech6/level2-3-recsys-finalproject-recsys-01/assets/35794681/1390e2f9-4bc0-4bf7-9ea8-7b6914a5fcf7)
+1. App 서버 : Front / Back 을 구분하여 운영 ([Streamlit](https://streamlit.io/) / [FastAPI](https://fastapi.tiangolo.com/ko/))
+2. DB 서버 : 레시피 및 인터렉션 데이터 저장, 가격 데이터 저장 ([MongoDB](https://www.mongodb.com/))
+3. Crawl 서버 : 크롤링 및 데이터 정제 수행 ([Airflow](https://airflow.apache.org/), [Selenium](https://www.selenium.dev/))
+4. ML 서버 : 배치 서빙 및 학습 자동화, 모델 관리 ([Airflow](https://airflow.apache.org/), [MLflow](https://mlflow.org/))
+
+## 서비스 핵심 기능 구조
+![image](https://github.com/boostcampaitech6/level2-3-recsys-finalproject-recsys-01/assets/35794681/2685bca0-fe69-44c3-ab24-94f774130b78)
+
+## 자동화 파이프라인
+![image](https://github.com/boostcampaitech6/level2-3-recsys-finalproject-recsys-01/assets/35794681/3f40c39b-997e-48fa-8d47-c87fe84c29ab)
+
+1. **크롤링 자동화**
+    - Airflow를 이용해 매일 새로운 학습 데이터(레시피 및 인터렉션 데이터) 수집, 이후 프롬프트 엔지니어링을 통해 레시피의 식재료명 정제 작업 진행
+    - 식제료명 정제 작업 이후, 정제된 식재료 명을 기반으로 매일 식재료 가격 정보를 새롭게 수집
+2. **배치 서빙 및 학습 자동화**
+    - Airflow를 이용해 매일 배치 서빙 진행, 매주 모델 재학습
+    - MLflow를 이용해 모델 학습을 트래킹하고 모델 버전 관리
+
+# 참고 자료
+[발표 영상](https://youtu.be/kUTHhSbEgLs) &nbsp;
+[랩업 리포트](https://github.com/boostcampaitech6/level2-3-recsys-finalproject-recsys-01/files/14821620/_Recsys_.01.pdf) &nbsp;
+[최종 발표자료](https://github.com/boostcampaitech6/level2-3-recsys-finalproject-recsys-01/files/14821646/RecSys_01_._0.1.7.pdf) &nbsp;