-
Notifications
You must be signed in to change notification settings - Fork 4
docs: README 추가 #162
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
The head ref may contain hidden characters: "docs/README\uCD94\uAC00"
Merged
docs: README 추가 #162
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,212 @@ | ||
| This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). | ||
|  | ||
|
|
||
| ## Getting Started | ||
| ## **📑 목차** | ||
|
|
||
| First, run the development server: | ||
| > ***[프로젝트 소개](#프로젝트-소개)*** | ||
| > | ||
| > ***[개발 기간](#개발-기간)*** | ||
| > | ||
| > ***[개발자 소개](#개발자-소개)*** | ||
| > | ||
| > ***[상세 계획](#상세-계획)*** | ||
| > | ||
| > ***[User Flow](#User-Flow)*** | ||
| > | ||
| > ***[프로젝트 구조](#프로젝트-구조)*** | ||
| > | ||
| > ***[개발 환경](#개발-환경)*** | ||
| > | ||
| > ***[기술 스택](#기술-스택)*** | ||
| > | ||
| > ***[주요 기능](#주요-기능)*** | ||
| > | ||
| > ***[배포 및 실행 방법](#배포-및-실행-방법)*** | ||
| > | ||
| </br> | ||
|
|
||
| ## 🧑💻 <a name="프로젝트-소개"/>프로젝트 소개 | ||
|
|
||
| 이 프로젝트는 [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) 으로 시작된 [Next.js](https://nextjs.org/) 프로젝트입니다. | ||
|
|
||
| Coworkers는 팀을 구성해서 할 일을 만들고, 공유하고 소통하면서 업무를 효율적으로 할 수 있게 돕는 서비스입니다. | ||
|
|
||
| </br> | ||
|
|
||
| ## 🔗 링크 | ||
|
|
||
| [GitHub](https://github.com/team-collabor/coworkers) | ||
|
|
||
| [🎬 시연 영상](https://www.youtube.com/watch?v=sF21zWhRcss) | ||
|
|
||
| [🌐 배포 사이트](https://coworkers-colla.netlify.app) | ||
|
|
||
| </br> | ||
|
|
||
| ## 👨🏫 <a name="주요-기능"/>주요 기능 | ||
|
|
||
| |||| | ||
| |:---:|:---:|:---:| | ||
| |**랜딩 페이지**|**팀 페이지**|**할 일 페이지**| | ||
|
|
||
| |||| | ||
| |:---:|:---:|:---:| | ||
| |**자유 게시판**|**계정 설정 페이지**|**마이 히스토리 페이지**| | ||
|
|
||
| </br> | ||
|
|
||
| ## 🗓️ <a name="개발-기간"/>개발 기간 | ||
|
|
||
| ***10 / 7 (목) ~ 11 / 14 (목)*** | ||
|
|
||
| </br> | ||
|
|
||
| ## **👨👨👦👦 개발자 소개** | ||
|
|
||
| - **김우성** [@me92years](https://github.com/me92years) : 마이 히스토리 페이지 | ||
| - **이승현** [@leesh7048](https://github.com/leesh7048) : 자유게시판 페이지 | ||
| - **옥승현** [@SeungHyunOK](https://github.com/SeungHyunOK) : 렌딩페이지 및 계정 설정 페이지 | ||
| - **정원식** [@wonsik3686](https://github.com/wonsik3686) : 할 일 페이지 | ||
| - **정인재** [@Injaeeee](https://github.com/Injaeeee?pvs=4,) : 팀 페이지 | ||
|
|
||
| </br> | ||
|
|
||
| ## 📃 <a name="상세-계획"/>상세 계획과 일정 | ||
|
|
||
| [**📌 상세 계획**](https://www.notion.so/wonsik/11309277475d81549fe7ebf0e04dae7d,) | ||
|
|
||
| [**📝 상세 일정**](https://www.notion.so/wonsik/11309277475d810db53ec53c248f89d7,) | ||
|
|
||
| </br> | ||
|
|
||
| ## 💡 <a name="User-Flow"/>User Flow | ||
|
|
||
|  | ||
|
|
||
| </br> | ||
|
|
||
| ## 📁 <a name="프로젝트-구조"/>프로젝트 구조 | ||
|
|
||
| ```bash | ||
| npm run dev | ||
| # or | ||
| yarn dev | ||
| # or | ||
| pnpm dev | ||
| # or | ||
| bun dev | ||
| ``` | ||
| 📁wine/ | ||
| │ | ||
| ├── 📁public/ | ||
| │ ├── 📁images/ # 이미지 파일 폴더 | ||
| │ └── 📁ic_wine.svg ... | ||
| │ | ||
| ├── 📁constants/ | ||
| │ └── 📁auth/ | ||
| │ └── mediaQueryBreakPoint.ts | ||
| │ | ||
| ├── 📁src/ | ||
| │ └── 📁components/ # 재사용 가능한 컴포넌트 | ||
| │ └── 📁common/ # 공통 컴포넌트 | ||
| │ ├── 📁Button/ | ||
| │ │ └── Button.tsx | ||
| │ └── 📁Toast/ | ||
| │ └── Toast.tsx | ||
| │ | ||
| ├── 📁pages/ # Next.js page 라우팅 | ||
| │ │ └── 📁signin/ | ||
| │ │ └── index.tsx | ||
| │ │ └── 📁signup/ | ||
| │ │ └── index.tsx | ||
| │ │ └── 📁[id]/ # 팀 페이지에 들어갈 컴포넌트 모음 | ||
| │ │ │ ├── 📁editteam/ | ||
| │ │ │ │ └── index.tsx | ||
| │ │ └── index.tsx | ||
| │ │ └── index.tsx | ||
| │ │ └── _app.tsx | ||
| │ │ └── _404.tsx | ||
| │ │ | ||
| │ ├── 📁libs/ # 라이브러리 관련된 세팅 및 함수들 정리하는 폴더 | ||
| │ │ └── 📁axios/ # axios 관련 세팅 및 api 요청 함수 | ||
| │ │ └── axiosInstance.ts | ||
| │ │ └── 📁auth/ | ||
| │ │ └── 📁image/ | ||
| │ │ └── 📁review/ | ||
| │ │ └── 📁user/ | ||
| │ │ └── 📁wine/ | ||
| │ │ | ||
| │ ├── 📁contexts/ # 전역 상태 관리 | ||
| │ │ | ||
| │ ├── 📁hooks/ # 커스텀 React 훅 | ||
| │ │ | ||
| │ ├── 📁types/ # 타입 폴더 (DTO 혹은 전역적으로 사용되는 type 미리 정의) | ||
| │ │ # 컴포넌트 props의 경우에는 해당 컴포넌트 위치에 정의 | ||
| │ │ | ||
| │ ├── 📁styles/ # 스타일 관련 파일 모음 | ||
| │ │ └── global.css | ||
| │ │ | ||
| │ │ | ||
| │ └── 📁utils/ # 유틸리티 폴더 | ||
| │ | ||
| ├─ .gitignore | ||
| ├─ .env.local # 각자 환경에서 별도 생성 필요 | ||
| ├─ .eslintrc.json | ||
| ├─ .prettierrc.json | ||
| ├─ next.confing.mjs | ||
| ├─ tailwind.config.ts | ||
| ├─ tsconfig.json | ||
| │ | ||
| ...생략 | ||
| ``` | ||
|
|
||
| </br> | ||
|
|
||
| ## 💻 <a name="개발-환경"/>개발 환경 | ||
|
|
||
| |OS|IDE|Version Control|Package Manager|deploy|Community| | ||
| |:---:|:---:|:---:|:---:|:---:|:---:| | ||
| | | | |||| | ||
|
|
||
| </br> | ||
|
|
||
| ## ⚒ <a name="기술-스택"/>기술 스택 | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| </br> | ||
|
|
||
| ## 🚀 <a name="배포-및-실행-방법"/>배포 및 실행 방법 | ||
|
|
||
| **1. 프로젝트 클론** | ||
|
|
||
| `git clone https://github.com/Codeit-FE08-Part3-Team6/wine.git cd wine](https://github.com/team-collabor/coworkers.git` | ||
|
|
||
| **2. 의존성 설치** | ||
|
|
||
| 프로젝트에서 사용하는 패키지들을 설치합니다. | ||
|
|
||
| `npm install` | ||
|
|
||
| **3. 개발 서버 실행** | ||
|
|
||
| Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. | ||
| 다음 명령어를 실행하여 로컬 개발 환경에서 프로젝트를 실행할 수 있습니다. | ||
|
|
||
| You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file. | ||
| `npm run dev` | ||
|
|
||
| [API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`. | ||
| 이후 브라우저에서 [http://localhost:3000](http://localhost:3000/) 으로 접속하여 개발 중인 웹 애플리케이션을 확인할 수 있습니다. | ||
|
|
||
| The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. | ||
| **4. 빌드 및 배포** | ||
|
|
||
| This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. | ||
| 프로덕션 환경에서 사용하기 위해 빌드할 때는 아래 명령어를 사용합니다. | ||
|
|
||
| ## Learn More | ||
| `npm run build` | ||
|
|
||
| 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. | ||
| `npm start` | ||
|
|
||
| You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! | ||
| **5. 배포** | ||
|
|
||
| ## Deploy on Vercel | ||
| 이 프로젝트는 netlify을 사용하여 배포할 수 있습니다. | ||
|
|
||
| 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. | ||
| GitHub와 연동된 netlify 계정을 통해 자동으로 배포되며, 코드를 push하면 자동으로 배포 프로세스가 진행됩니다. | ||
|
|
||
| Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. | ||
| [**배포 사이트**](https://wine-nine-xi.vercel.app/?pvs=4%5D(https://coworkers-colla.netlify.app/,) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
이 코드 패치는 Next.js 프로젝트를 설명하는 내용을 한국어로 변경하고, 프로젝트 개요, 개발 기간, 개발자 소개, 상세 계획, User Flow, 프로젝트 구조, 개발 환경, 기술 스택, 배포 및 실행 방법 등을 설명하고 있습니다.
코드 리뷰에서 발견된 버그나 개선 사항은 거의 없어 보입니다. 다만, 중요한 부분은 코드보다는 문서화 및 설명 내용에 중점을 두고 있어서 코드 부분이 충분히 검토되었는지 다시 확인할 필요가 있습니다. 또한, 이미지 및 링크 관련 부분을 더 자세히 설명하거나 추가할 수 있을 것입니다.
코드와 관련된 부분은 코드 블록의 주석이 지워지거나 변경된 것이 없는지, 코드 변경이 누락되었는지 등을 다시 확인하는 것이 좋겠습니다. 반드시 코드와 설명 사이의 링크나 일관성을 유지하도록 신중히 검토해야 합니다. 계속해서 코드와 설명 부분이 일치하는지 확인하는 것이 중요합니다.