|
1 | | -AlgorithmChef_Frontend |
| 1 | +# 알고리즘 셰프 - Algorithm Chef |
| 2 | + |
| 3 | +환영합니다! 이 프로젝트는 Anima에 의해 자동으로 생성된 React 애플리케이션입니다. |
| 4 | +"알고리즘 셰프"는 사용자의 냉장고 속 식재료와 개인 성향을 기반으로 맞춤형 레시피를 추천하고, 식재료 나눔 커뮤니티를 제공하는 서비스입니다. |
| 5 | + |
| 6 | +## 시작하기 |
| 7 | + |
| 8 | +> **전제 조건:** |
| 9 | +> 다음 단계를 수행하려면 시스템에 [NodeJS](https://nodejs.org/en/)가 설치되어 있어야 합니다. |
| 10 | +
|
| 11 | +프로젝트를 시작하려면 먼저 다음 명령어로 의존성을 설치해야 합니다: |
| 12 | + |
| 13 | +```bash |
| 14 | +npm install |
| 15 | +``` |
| 16 | + |
| 17 | +그 다음, 다음 명령어로 개발 버전을 실행할 수 있습니다: |
| 18 | + |
| 19 | +```bash |
| 20 | +npm run dev |
| 21 | +``` |
| 22 | + |
| 23 | +몇 초 후, 프로젝트는 [http://localhost:5173/](http://localhost:5173/) 주소에서 접근할 수 있습니다. |
| 24 | + |
| 25 | +결과에 만족하면, 다음 명령어로 릴리스용 프로젝트를 빌드할 수 있습니다: |
| 26 | + |
| 27 | +```bash |
| 28 | +npm run build |
| 29 | +``` |
| 30 | + |
| 31 | +## 주요 기능 |
| 32 | + |
| 33 | +* **반응형 디자인**: 모든 페이지는 다양한 화면 크기(데스크톱, 태블릿, 모바일)에 최적화되어 있습니다. |
| 34 | +* **통합 헤더**: 모든 페이지에 일관된 탐색 및 인증 기능을 제공하는 단일 헤더 컴포넌트가 적용되었습니다. |
| 35 | +* **메뉴 내비게이션**: 헤더 좌측의 햄버거 메뉴를 통해 주요 페이지(홈, 메뉴 추천, 재료 나눔 게시판, 마이페이지)로 쉽게 이동할 수 있습니다. |
| 36 | +* **사용자 인증**: |
| 37 | + * 로그인 및 회원가입 팝업 시스템. |
| 38 | + * 성별, 생년월일 입력 및 성향(건강 목표, 알레르기, 선호/비선호 재료, 선호 요리, 매운맛 선호도, 알림 설정) 선택 기능. |
| 39 | + * 로그인 시 사용자 이름 표시 및 로그아웃 버튼으로 전환. |
| 40 | + * 아이디/비밀번호 유효성 검사 및 중복 아이디 확인 (현재 `localStorage` 기반 목업). |
| 41 | +* **나의 냉장고**: |
| 42 | + * 식재료 목록을 카테고리별로 필터링하고 검색할 수 있습니다. |
| 43 | + * 새로운 식재료를 추가하거나 영수증을 등록할 수 있는 기능 (팝업 및 전용 페이지). |
| 44 | +* **메뉴 추천**: |
| 45 | + * Gemini API와 연동될 검색창 (현재 목업). |
| 46 | + * 식재료 기반 및 성향 기반 자동 메뉴 추천 기능. |
| 47 | + * 레시피 카드를 최대 12개까지 표시하며, 좌우 스크롤 버튼으로 페이지 이동 가능. |
| 48 | + * 각 레시피 카드를 클릭하면 상세 레시피 페이지로 이동합니다. |
| 49 | +* **재료 나눔 게시판**: |
| 50 | + * 게시글 목록을 페이지네이션(최대 5페이지)으로 탐색할 수 있습니다. |
| 51 | + * 로그인한 사용자만 새 글을 작성할 수 있습니다. |
| 52 | + * 각 게시글은 고유한 댓글 기능을 가지며, 댓글은 `localStorage`에 저장됩니다. |
| 53 | + * 게시글 상세 페이지에서 현재 게시글의 앞뒤 2개씩, 총 4개의 관련 게시글을 표시합니다. |
| 54 | +* **마이페이지**: |
| 55 | + * 로그인 상태에 따라 사용자 성향 정보를 표시하거나 로그인 요청 메시지를 출력합니다. |
| 56 | + * 사용자의 건강 목표, 알레르기, 선호/비선호 재료, 선호 요리, 매운맛 선호도, 알림 설정을 확인할 수 있습니다. |
| 57 | + |
| 58 | +## 백엔드 연동 가이드 |
| 59 | + |
| 60 | +이 프로젝트는 프론트엔드 기능 구현에 중점을 두었으며, 모든 데이터는 현재 `localStorage`를 사용하여 목업(mockup)으로 처리됩니다. 실제 백엔드와 연동하려면 다음 지침을 따르세요: |
| 61 | + |
| 62 | +1. **API 클라이언트 설치**: `axios`와 같은 HTTP 클라이언트 라이브러리를 설치합니다. |
| 63 | + ```bash |
| 64 | + npm install axios |
| 65 | + ``` |
| 66 | + |
| 67 | +2. **API 엔드포인트 정의**: 백엔드에서 제공하는 API 엔드포인트를 정의합니다. 예: |
| 68 | + * `GET /api/users/{username}/ingredients` (사용자 냉장고 재료) |
| 69 | + * `GET /api/ingredients/all` (모든 식재료 DB) |
| 70 | + * `POST /api/ingredients` (식재료 추가) |
| 71 | + * `POST /api/login` (로그인) |
| 72 | + * `POST /api/signup` (회원가입) |
| 73 | + * `POST /api/users/{username}/preferences` (사용자 성향 저장) |
| 74 | + * `GET /api/users/{username}/preferences` (사용자 성향 조회) |
| 75 | + * `GET /api/posts` (모든 게시글) |
| 76 | + * `POST /api/posts` (새 게시글 작성) |
| 77 | + * `GET /api/posts/{id}/comments` (게시글 댓글 조회) |
| 78 | + * `POST /api/posts/{id}/comments` (댓글 작성) |
| 79 | + * `GET /api/recommend/ingredients` (식재료 기반 레시피 추천) |
| 80 | + * `GET /api/recommend/tendencies` (성향 기반 레시피 추천) |
| 81 | + * `POST /api/gemini-search` (Gemini API 검색) |
| 82 | + |
| 83 | +3. **목업 데이터 교체**: 프로젝트 코드 내의 `// TODO: Backend Integration: Replace with API call` 주석을 찾아 `localStorage`를 사용하는 목업 로직을 실제 `axios` 호출로 교체합니다. |
| 84 | + |
| 85 | + **예시 (로그인):** |
| 86 | + ```javascript |
| 87 | + // src/components/LoginPopup/LoginPopup.jsx |
| 88 | + const handleLogin = async (e) => { |
| 89 | + e.preventDefault(); |
| 90 | + try { |
| 91 | + const response = await axios.post('/api/login', { username, password }); |
| 92 | + login(response.data.user); // Assuming backend returns user data |
| 93 | + onClose(); |
| 94 | + } catch (error) { |
| 95 | + alert("아이디 또는 비밀번호가 일치하지 않습니다."); |
| 96 | + console.error("Login error:", error); |
| 97 | + } |
| 98 | + }; |
| 99 | + ``` |
| 100 | +
|
| 101 | + **예시 (게시글 목록):** |
| 102 | + ```javascript |
| 103 | + // src/screens/CommunityPage/sections/Communitypage/Communitypage.jsx |
| 104 | + useEffect(() => { |
| 105 | + const fetchPosts = async () => { |
| 106 | + try { |
| 107 | + const response = await axios.get('/api/posts'); |
| 108 | + setAllPosts(response.data); |
| 109 | + } catch (error) { |
| 110 | + console.error("Failed to fetch posts:", error); |
| 111 | + setAllPosts(DEFAULT_POSTS); // Fallback to default posts |
| 112 | + } |
| 113 | + }; |
| 114 | + fetchPosts(); |
| 115 | + }, []); |
| 116 | + ``` |
| 117 | +
|
| 118 | +4. **환경 변수 설정**: API의 기본 URL 등은 `.env` 파일을 사용하여 관리하는 것이 좋습니다. |
| 119 | + ``` |
| 120 | + VITE_API_BASE_URL=http://localhost:8080/api |
| 121 | + ``` |
| 122 | + 그리고 코드에서는 `import.meta.env.VITE_API_BASE_URL`과 같이 접근합니다. |
| 123 | +
|
| 124 | +이 가이드를 통해 "알고리즘 셰프" 프론트엔드를 실제 백엔드 서비스와 성공적으로 연동할 수 있을 것입니다. |
0 commit comments