Update README.md

README.md

@@ -1,36 +1,126 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+# 📜 3Team 프로젝트 : PikCha
 
-## Getting Started
+코드잇 파트4 TEAM3 최종 프로젝트
 
-First, run the development server:
+> ![TypeScript](https://img.shields.io/badge/-TypeScript-3178C6?logo=typescript&logoColor=white&labelColor=20232a)
+> ![Next.js](https://img.shields.io/badge/-Next.js-000000?logo=next.js&logoColor=white&labelColor=20232a)
+> ![React](https://img.shields.io/badge/-React-61DAFB?logo=react&logoColor=white&labelColor=20232a)
+> ![Tailwind CSS](https://img.shields.io/badge/-Tailwind_CSS-06B6D4?logo=tailwindcss&logoColor=white&labelColor=20232a)
+> ![shadcn/ui](https://img.shields.io/badge/-shadcn%2Fui-000000?logo=react&logoColor=white&labelColor=20232a)
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+> ![Prettier](https://img.shields.io/badge/-Prettier-F7B93E?logo=prettier&logoColor=white&labelColor=20232a)
+> ![ESLint](https://img.shields.io/badge/-ESLint-4B32C3?logo=eslint&logoColor=white&labelColor=20232a)
+> ![Husky](https://img.shields.io/badge/-Husky-000000?logo=git&logoColor=white&labelColor=20232a)
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+> ![OAuth](https://img.shields.io/badge/-OAuth2.0-3C3C3D?logo=auth0&logoColor=white&labelColor=20232a)
+> ![Zustand](https://img.shields.io/badge/-Zustand-FF6F61?logo=react&logoColor=white&labelColor=20232a)
+> ![Vercel](https://img.shields.io/badge/-Vercel-000000?logo=vercel&logoColor=white&labelColor=20232a)
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+> ![Git](https://img.shields.io/badge/-Git-F05032?logo=git&logoColor=white&labelColor=20232a)
+> ![GitHub](https://img.shields.io/badge/-GitHub-181717?logo=github&logoColor=white&labelColor=20232a)
+> ![Notion](https://img.shields.io/badge/-Notion-000000?logo=notion&logoColor=white&labelColor=20232a)
+> ![Linear](https://img.shields.io/badge/-Linear-5E6AD2?logo=linear&logoColor=white&labelColor=20232a)
 
-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+---
 
-## Learn More
+## 🚀 배포 사이트
 
-To learn more about Next.js, take a look at the following resources:
+- [🧷 배포 서비스](https://mogazoa-smoky.vercel.app/)
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+---
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+## 💡 프로젝트 개요
 
-## Deploy on Vercel
+[PikCha]는 다양한 영화에서 두 가지를 선택해 **A/B 테스트로 비교**하는 웹 애플리케이션입니다.  
+사용자는 결과를 공유하고, 후기·별점 데이터를 기반으로 영화 랭킹을 확인할 수 있습니다.
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+- [🧷 요구사항 가이드](https://www.notion.so/631abba6780048859d73d74eabf0070f?pvs=21)  
+- [🧷 API 문서 (Swagger)](https://mogazoa-api.vercel.app/docs/#/)  
+- [🧷 Figma - 디자인](https://www.figma.com/design/mo37KmYpd3ZsJ6Ojay2u83/%5BCCC%5DMogazoa?node-id=0-1&t=tcmXymiGLgoJ6for-1)  
+- [🧷 Figma - User Flow](https://www.figma.com/board/dst53QIQUDpW5ZTefQLntS/mogajoa-userflow?node-id=0-1&p=f&t=ZTPVGfnpShbiv65H-0)  
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+---
+
+## 📝 프로젝트 문서
+
+- [🧷 수행 계획서](https://www.notion.so/25405a1cda5a808695a7d738d0fdd9c4?pvs=21)  
+- [🧷 프로젝트 일정관리](https://www.notion.so/25405a1cda5a80bc8345e1b637c6dca5?pvs=21)  
+- [🧷 구현 상세 계획](https://www.notion.so/25405a1cda5a8040bc02e47eab05c1b7?pvs=21)  
+
+---
+
+## 📅 프로젝트 일정
+
+8월 3주차 (2024.08.19 ~ 08.25)  
+| 작업 항목 | 8.19 | 8.20 | 8.21 | 8.22 | 8.23 | 8.24 | 8.25 |
+|----------|:----:|:----:|:----:|:----:|:----:|:----:|:----:|
+| 프로젝트 시작 | ■ | | | | | | |
+| 기획 및 환경 설정 | ■ | ■ | ■ | | | | |
+| 초기 개발 | | ■ | ■ | ■ | ■ | | |
+
+9월 1주차 (2024.09.01 ~ 09.07)  
+| 작업 항목 | 9.01 | 9.02 | 9.03 | 9.04 | 9.05 | 9.06 | 9.07 |
+|----------|:----:|:----:|:----:|:----:|:----:|:----:|:----:|
+| 주요 기능 개발 | ■ | ■ | ■ | ■ | ■ | | |
+| QA & 버그 수정 | | | | ■ | ■ | ■ | |
+| 중간 점검 | | | | | | | ■ |
+
+9월 2주차 (2024.09.08 ~ 09.14)  
+| 작업 항목 | 9.08 | 9.09 | 9.10 | 9.11 | 9.12 | 9.13 | 9.14 |
+|----------|:----:|:----:|:----:|:----:|:----:|:----:|:----:|
+| 세부 기능 개발 | ■ | ■ | ■ | ■ | ■ | | |
+| 통합 테스트 | | | | | ■ | ■ | |
+| 발표 준비 | | | | | | | ■ |
+
+---
+
+## 👥 팀 구성 및 역할
+
+| 이름 | 역할 |
+|------|-------------------------|
+| 김성주 | 유저정보, 내정보, 팔로워/팔로잉 모달 | 
+| 나소연 | 메인, 비교하기 모달, GNB, 컬러·폰트 |
+| 남만재 | 상품 상세, 상품 등록/편집, 리뷰 기능 |
+| 배민지 | 로그인, 회원가입, 폼/입력 UI |
+
+---
+
+## 🔍 QA & 코드 리뷰
+- [🧷 QA 체크리스트](https://www.notion.so/25e05a1cda5a80ff8772e35060c6ddd2?pvs=21)  
+- [🧷 2차 QA 체크리스트](https://www.notion.so/26505a1cda5a808e8f02e24e58c5f205?pvs=21)  
+
+**코드 리뷰 담당자**
+| 작성자 | 리뷰어 |
+|--------|--------|
+| 김성주 | 나소연, 남만재 |
+| 나소연 | 남만재, 배민지 |
+| 남만재 | 배민지, 김성주 |
+| 배민지 | 김성주, 나소연 |
+
+---
+
+## 🎨 디자인 & 요구사항
+- [🧷 User Flow](https://www.figma.com/board/dst53QIQUDpW5ZTefQLntS/mogajoa-userflow?node-id=0-1&p=f&t=ZTPVGfnpShbiv65H-0)  
+- [🧷 요구사항](https://docs.google.com/spreadsheets/d/13eRz1_guXs7pYHc8VXqhDdhGtIV06gvn9Pc64pF2dUI/edit?gid=0#gid=0)  
+
+---
+
+## 🔌 기술 스택
+- **Frontend**: Next.js 15(App Router), React, TypeScript, Tailwind CSS v4, shadcn/ui  
+- **State Management**: Zustand  
+- **Auth**: OAuth2.0, NextAuth  
+- **Form & Validation**: react-hook-form, zod  
+- **Build & Deploy**: Webpack, Vercel  
+- **Collaboration**: GitHub, Linear, Notion  
+
+---
+
+## 📚 참고 문서
+- [TypeScript](https://www.typescriptlang.org/docs/)  
+- [React](https://react.dev/)  
+- [Next.js](https://nextjs.org/docs)  
+- [Tailwind CSS](https://tailwindcss.com/docs)  
+- [shadcn/ui](https://ui.shadcn.com/docs/components)  
+- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction)  
+- [Vercel](https://vercel.com/docs)  
+- [OAuth 2.0](https://oauth.net/2/)