From 8cff717d13828a86ec891189a979175766630b29 Mon Sep 17 00:00:00 2001 From: cloud0406 <32586926+cloud0406@users.noreply.github.com> Date: Fri, 17 Jan 2025 11:42:57 +0900 Subject: [PATCH 1/2] =?UTF-8?q?=08=F0=9F=93=9D[Docs]=20=EB=A6=AC=EB=93=9C?= =?UTF-8?q?=EB=AF=B8=20=ED=8F=AC=EB=A7=B7=20=EC=A0=81=EC=9A=A9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 69 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 46 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index e215bc4c..46d5b18a 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,59 @@ -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). +
+image -## Getting Started +> πŸ“– λ‹Ήμ‹ μ˜ λ…μ„œ μƒν™œμ— μƒˆλ‘œμš΄ νŽ˜μ΄μ§€λ₯Ό μ—΄μ–΄λ³΄μ„Έμš”! +
μƒˆλ‘œμš΄ μ‚¬λžŒλ“€κ³Ό ν•¨κ»˜ 읽고 λ‚˜λˆ„λŠ” νŠΉλ³„ν•œ λ…μ„œ κ²½ν—˜, **뢁코**κ°€ ν•¨κ»˜ν•©λ‹ˆλ‹€. +>
+
[![Bookco](https://img.shields.io/badge/BOOKCO.SITE-00a991?style=for-the-badge)](https://bookco.vercel.app/) +
+
+
-```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` +## 🎯 Bookcoμ—μ„œ ν•  수 μžˆλŠ” 일 -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +- **πŸ‘₯ λ…μ„œ λͺ¨μž„** + + λΉ„μŠ·ν•œ μ·¨ν–₯을 가진 μ‚¬λžŒλ“€κ³Ό ν•¨κ»˜ 책을 읽고 이야기λ₯Ό λ‚˜λˆŒ 수 μžˆμŠ΅λ‹ˆλ‹€. + - 정해진 μ±…μœΌλ‘œ λ…μ„œ λͺ¨μž„에 μ°Έμ—¬ν•˜κ±°λ‚˜, 직접 λͺ¨μž„을 λ§Œλ“€ 수 μžˆμŠ΅λ‹ˆλ‹€. -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +- πŸ’¬Β **μ±„νŒ…ν•˜κΈ°** + + λ‹€λ₯Έ 뢁코 μœ μ €λ“€κ³Ό μ±„νŒ… κΈ°λŠ₯을 톡해 μ†Œν†΅ν•  수 μžˆμŠ΅λ‹ˆλ‹€. + - λͺ¨μž„μ˜ ν˜ΈμŠ€νŠΈλ‚˜ κ΅ν™˜ν•˜κ³  싢은 책을 가진 μœ μ €μ™€ λŒ€ν™”λ₯Ό λ‚˜λˆŒ 수 μžˆμŠ΅λ‹ˆλ‹€. + +- **πŸ“š κ΅ν™˜ν•˜κΈ° (μΆ”ν›„ 개발 μ˜ˆμ •..)** + + μ•ˆ 보게 된 책을 λ“±λ‘ν•˜λ©΄, λ‹€λ₯Έ μ‚¬λžŒμ˜ μ±…κ³Ό λ°”κΏ” 읽을 수 μžˆμŠ΅λ‹ˆλ‹€. + - μ§‘μ—μ„œ 방치되던 책을 λ‹€λ₯Έ μœ μ €μ™€ κ³΅μœ ν•  수 μžˆμŠ΅λ‹ˆλ‹€. -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: +
+
-- [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 +## πŸ“‚ 폴더 ꡬ쑰 + +
+
+ +## 🀝 νŒ€ ν˜‘μ—… 방식, 브랜치 μ „λž΅ + +
+
+ +## πŸ‘₯ νŒ€μ› ꡬ성 + +
+
-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. -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. From 8e65f55d91426381f87e29694c043cf0d4a36422 Mon Sep 17 00:00:00 2001 From: cloud0406 <32586926+cloud0406@users.noreply.github.com> Date: Fri, 17 Jan 2025 12:07:54 +0900 Subject: [PATCH 2/2] =?UTF-8?q?=EB=A6=AC=EB=93=9C=EB=AF=B8=20=EC=97=85?= =?UTF-8?q?=EB=8D=B0=EC=9D=B4=ED=8A=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 59 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 46d5b18a..d6c3cff8 100644 --- a/README.md +++ b/README.md @@ -33,27 +33,81 @@ ## πŸ“š μ„œλΉ„μŠ€ μ†Œκ°œ +image +image +image +image +image +image +image +image +image +

## πŸ› οΈ κΈ°μˆ μŠ€νƒ -
-
+### πŸ’» Core +![Next.js](https://img.shields.io/badge/Next.js-000000?style=for-the-badge&logo=next.js&logoColor=white) +![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white) + +### πŸ”„ μƒνƒœ 관리 +![TanStack Query](https://img.shields.io/badge/TanStack_Query-FF4154?style=for-the-badge&logo=reactquery&logoColor=white) +![Zustand](https://img.shields.io/badge/Zustand-000000?style=for-the-badge) + +### 🌐 톡신 +![Axios](https://img.shields.io/badge/Axios-5A29E4?style=for-the-badge&logo=axios&logoColor=white) +![SockJS](https://img.shields.io/badge/SockJS-000000?style=for-the-badge&logo=socket.io&logoColor=white) +![STOMP](https://img.shields.io/badge/STOMP-000000?style=for-the-badge) + +### 🎨 μŠ€νƒ€μΌλ§ +![Tailwind CSS](https://img.shields.io/badge/Tailwind_CSS-06B6D4?style=for-the-badge&logo=tailwindcss&logoColor=white) + +### βš™οΈ μœ ν‹Έλ¦¬ν‹° +![Zod](https://img.shields.io/badge/Zod-3E67B1?style=for-the-badge&logo=zod&logoColor=white) -## πŸ“‚ 폴더 ꡬ쑰 +### πŸ§ͺ ν…ŒμŠ€νŒ… +![Jest](https://img.shields.io/badge/Jest-C21325?style=for-the-badge&logo=jest&logoColor=white) +![React Testing Library](https://img.shields.io/badge/React_Testing_Library-E33332?style=for-the-badge&logo=testing-library&logoColor=white) +![Storybook](https://img.shields.io/badge/Storybook-FF4785?style=for-the-badge&logo=storybook&logoColor=white) + +### πŸ“‹ μ½”λ“œ ν’ˆμ§ˆ +![ESLint](https://img.shields.io/badge/ESLint-4B32C3?style=for-the-badge&logo=eslint&logoColor=white) +![Prettier](https://img.shields.io/badge/Prettier-F7B93E?style=for-the-badge&logo=prettier&logoColor=black) +![Husky](https://img.shields.io/badge/Husky-000000?style=for-the-badge)

## 🀝 νŒ€ ν˜‘μ—… 방식, 브랜치 μ „λž΅ +### βœ… **PR 리뷰 방식** +- **2λͺ… Approve** 방식 +- PR 확인 μ‹œκ°„ κ³ μ •: `09:00`, `13:00`, `18:00` +- **Pn λ£°**κ³Ό **Dn λ£°** 적용 +- **데일리 슀크럼** 진행 + +### βœ… **브랜치 μ „λž΅** +- **GitHub Flow** 적용 + - `feature` β†’ `develop` β†’ `main` + - `hotfix` λŠ” Mainμ—μ„œ κΈ‰ν•˜κ²Œ μˆ˜μ •ν•  일 μžˆμ„ λ•Œ μ‚¬μš© + +### βœ… **CI/CD μ „λž΅** +- **Husky**λ₯Ό ν†΅ν•œ μ½”λ“œ ν’ˆμ§ˆ 관리 + - μ»€λ°‹μ‹œ 린트 검사 +- **λ””μŠ€μ½”λ“œ μ›Ήν›… μ—°κ²°**둜 μ‹€μ‹œκ°„ μ•Œλ¦Ό +- PR μž‘μ„±μ‹œ Lint 검사, test μ½”λ“œ μ‹€ν–‰, μŠ€ν† λ¦¬λΆ λΉŒλ“œ, ν”„λ‘œλ•μ…˜ λΉŒλ“œ μ‹€ν–‰ν•˜μ—¬ 검사 +

## πŸ‘₯ νŒ€μ› ꡬ성 -
-
+|FE|FE|FE|FE| +|:---:|:---:|:---:|:---:| +||||| +|[김선ꡬ](https://github.com/haegu97)|[κΉ€λ―Όκ²½](https://github.com/wynter24)|[μ‹ μ„ ](https://github.com/sunnwave)|[κΉ€μ •ν˜Έ](https://github.com/cloud0406)| +