diff --git a/README.md b/README.md index e215bc4c..8568eacd 100644 --- a/README.md +++ b/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/)