Skip to content

Update README.md #167

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.

Sign up for GitHub

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

Closed
Injaeeee wants to merge 1 commit into from
Closed

Update README.md #167

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 26 additions & 55 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
![header](https://capsule-render.vercel.app/api?type=waving&color=047857&height=250&section=header&text=COWORKERS&fontSize=80&fontAlignY=40&fontColor=ffffff)
![header](https://capsule-render.vercel.app/api?type=waving&color=F76388&height=250&section=header&text=LOOKY&fontSize=80&fontAlignY=40&fontColor=000000)

## **📑 목차**

> ***[프로젝트 소개](#프로젝트-소개)***
>
> ***[개발 기간](#개발-기간)***
>
> ***[개발자 소개](#개발자-소개)***
>
> ***[상세 계획](#상세-계획)***
>
> ***[User Flow](#User-Flow)***
Expand All @@ -27,61 +25,46 @@

## 🧑‍💻 <a name="프로젝트-소개"/>프로젝트 소개

이 프로젝트는 [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) 으로 시작된 [Next.js](https://nextjs.org/) 프로젝트입니다.

Coworkers는 팀을 구성해서 할 일을 만들고, 공유하고 소통하면서 업무를 효율적으로 할 수 있게 돕는 서비스입니다.
LOOKY는

</br>

## 🔗 링크

[GitHub](https://github.com/team-collabor/coworkers)

[🎬 시연 영상](https://www.youtube.com/watch?v=sF21zWhRcss)
[GitHub](https://github.com/Injaeeee/looky)

[🌐 배포 사이트](https://coworkers-colla.netlify.app)
[🌐 배포 사이트](https://looky-cz8x.vercel.app/)

</br>

## 👨‍🏫 <a name="주요-기능"/>주요 기능

|![image](https://github.com/user-attachments/assets/31c20b48-9c9e-4894-b560-de0630da47d2)|![image](https://github.com/user-attachments/assets/553dcfc9-d308-4e3d-a0a3-60dd602900c4)|![image](https://github.com/user-attachments/assets/0e1908e3-88e1-4f30-baf9-bb6ec3abb8ec)|
|![image](https://github.com/user-attachments/assets/96091afc-d694-4bfb-bc68-9aa3f58374f7)|![image](https://github.com/user-attachments/assets/4d22324e-1b30-489e-bfd9-60abaca81b11)|![image](https://github.com/user-attachments/assets/8efc73c7-002a-4814-806a-e11663c0b276)|
|:---:|:---:|:---:|
|**랜딩 페이지**|**팀 페이지**|**할 일 페이지**|
|**랜딩 페이지**|**게시물 목록 페이지**|**게시물 생성 모달**|

|![image](https://github.com/user-attachments/assets/6b3ed4c5-ed2a-4c8c-ae32-8f7d9622b67a)|![image](https://github.com/user-attachments/assets/50679453-8afa-4185-8aa1-03f14e3eb6e2)|![image](https://github.com/user-attachments/assets/1432afe2-988e-404f-81a2-c23e313f4049)|
|![image](https://github.com/user-attachments/assets/56fce0a5-7e44-499c-b3df-4dd733e5c67d)|![image](https://github.com/user-attachments/assets/73514a5d-7deb-404f-918f-f3a084f88d4a)|![image](https://github.com/user-attachments/assets/1725025c-11a7-4e84-895a-103062756d0e)|
|:---:|:---:|:---:|
|**자유 게시판**|**계정 설정 페이지**|**마이 히스토리 페이지**|
|**랭킹 페이지**|**마이 페이지**|**회원가입 페이지**|

</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,) : 팀 페이지
***12 / 23 (목) ~ 1 / 26 (일)***

</br>

## 📃 <a name="상세-계획"/>상세 계획과 일정

[**📌 상세 계획**](https://www.notion.so/wonsik/11309277475d81549fe7ebf0e04dae7d,)

[**📝 상세 일정**](https://www.notion.so/wonsik/11309277475d810db53ec53c248f89d7,)
[**📌 상세 계획**](https://mud-stranger-c40.notion.site/Looky-15a06acd0113803a85b4f13fbdf04cdf?pvs=4)

</br>

## 💡 <a name="User-Flow"/>User Flow

![코워커스 유저플로우](https://github.com/user-attachments/assets/8a985e36-821c-495c-93bf-64154343e896)
![유저플로우](https://github.com/user-attachments/assets/50e4ed62-94cb-48b6-99ae-50825e1a3319)

</br>

Expand Down Expand Up @@ -135,18 +118,16 @@ Coworkers는 팀을 구성해서 할 일을 만들고, 공유하고 소통하면
│ ├── 📁types/ # 타입 폴더 (DTO 혹은 전역적으로 사용되는 type 미리 정의)
│ │ # 컴포넌트 props의 경우에는 해당 컴포넌트 위치에 정의
│ │
│ ├── 📁styles/ # 스타일 관련 파일 모음
│ ├── 📁style/ # 스타일 관련 파일 모음
│ │ └── global.css
│ │
│ │
│ └── 📁utils/ # 유틸리티 폴더
│ └── 📁util/ # 유틸리티 폴더
│
├─ .gitignore
├─ .env.local # 각자 환경에서 별도 생성 필요
├─ .env.local
├─ .eslintrc.json
├─ .prettierrc.json
├─ next.confing.mjs
├─ tailwind.config.ts
├─ tsconfig.json
│
...생략
Expand All @@ -157,27 +138,26 @@ Coworkers는 팀을 구성해서 할 일을 만들고, 공유하고 소통하면

## 💻 <a name="개발-환경"/>개발 환경

|OS|IDE|Version Control|Package Manager|deploy|Community|
|:---:|:---:|:---:|:---:|:---:|:---:|
|![macOS](https://img.shields.io/badge/macOS-000000?style=for-the-badge&logo=apple&logoColor=white) ![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)|![Visual Studio Code](https://img.shields.io/badge/Visual_Studio_Code-0078d7?style=for-the-badge&logo=visual-studio-code&logoColor=white) ![IntelliJ IDEA](https://img.shields.io/badge/IntelliJ_IDEA-000000?style=for-the-badge&logo=intellij-idea&logoColor=white)|![Git](https://img.shields.io/badge/Git-F05032?style=for-the-badge&logo=git&logoColor=white) ![GitHub](https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=github&logoColor=white)|![npm](https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white)|![Vercel](https://img.shields.io/badge/Vercel-000000?style=for-the-badge&logo=vercel&logoColor=white)|![Discord](https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)![Notion](https://img.shields.io/badge/Notion-000000?style=for-the-badge&logo=notion&logoColor=white)|

|OS|IDE|Version Control|Package Manager|deploy|
|:---:|:---:|:---:|:---:|:---:|
|![macOS](https://img.shields.io/badge/macOS-000000?style=for-the-badge&logo=apple&logoColor=white) ![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)|![Visual Studio Code](https://img.shields.io/badge/Visual_Studio_Code-0078d7?style=for-the-badge&logo=visual-studio-code&logoColor=white)|![Git](https://img.shields.io/badge/Git-F05032?style=for-the-badge&logo=git&logoColor=white) ![GitHub](https://img.shields.io/badge/GitHub-181717?style=for-the-badge&logo=github&logoColor=white)|![npm](https://img.shields.io/badge/npm-CB3837?style=for-the-badge&logo=npm&logoColor=white)|![Vercel](https://img.shields.io/badge/Vercel-000000?style=for-the-badge&logo=vercel&logoColor=white)|
</br>

## ⚒ <a name="기술-스택"/>기술 스택

![React](https://img.shields.io/badge/React-61DAFB?style=for-the-badge&logo=react&logoColor=white)
![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-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
![Tailwind CSS](https://img.shields.io/badge/Tailwind_CSS-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)
![Axios](https://img.shields.io/badge/Axios-5A29E4?style=for-the-badge&logo=axios&logoColor=white)
![Styled Components](https://img.shields.io/badge/Styled%20Components-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)
![Firebase](https://img.shields.io/badge/Firebase-FFCA28?style=for-the-badge&logo=firebase&logoColor=white)


</br>

## 🚀 <a name="배포-및-실행-방법"/>배포 및 실행 방법

**1. 프로젝트 클론**

`git clone https://github.com/Codeit-FE08-Part3-Team6/wine.git cd wine](https://github.com/team-collabor/coworkers.git`
`git clone https://github.com/Injaeeee/looky.git`

**2. 의존성 설치**

Expand All @@ -189,24 +169,15 @@ Coworkers는 팀을 구성해서 할 일을 만들고, 공유하고 소통하면

다음 명령어를 실행하여 로컬 개발 환경에서 프로젝트를 실행할 수 있습니다.

`npm run dev`
`npm run start`

이후 브라우저에서 [http://localhost:3000](http://localhost:3000/) 으로 접속하여 개발 중인 웹 애플리케이션을 확인할 수 있습니다.

**4. 빌드 및 배포**

프로덕션 환경에서 사용하기 위해 빌드할 때는 아래 명령어를 사용합니다.

`npm run build`

그 후, 아래 명령어로 빌드된 파일을 실제로 실행합니다.

`npm start`

**5. 배포**
**4. 배포**

이 프로젝트는 netlify을 사용하여 배포할 수 있습니다.
이 프로젝트는 Vercel을 사용하여 배포할 수 있습니다.

GitHub와 연동된 netlify 계정을 통해 자동으로 배포되며, 코드를 push하면 자동으로 배포 프로세스가 진행됩니다.
GitHub와 연동된 Vercel 계정을 통해 자동으로 배포되며, 코드를 push하면 자동으로 배포 프로세스가 진행됩니다.

[**배포 사이트**](https://wine-nine-xi.vercel.app/?pvs=4%5D(https://coworkers-colla.netlify.app/,)
[**배포 사이트**](https://looky-cz8x.vercel.app/)
Copy link

@github-actions github-actions bot Jan 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

코드 리뷰를 통해 발견된 몇 가지 사항은 다음과 같습니다:

  1. README.md에서 Coworkers가 LOOKY로 변경되었지만, 해당 변경으로 인한 기능이나 내용적인 수정이 이루어지지 않았습니다. LOOKY에 대한 설명이 부족하며, 변경된 이름에 대한 이유 또는 배경 정보가 없습니다.
  2. 개발 기간이 3개월로 기재되어 있으나, 실제로는 1개월(12/23 ~ 1/26)로 기재되어야 합니다.
  3. 개발자 소개 파트가 제거되었는데, 제거된 이유가 명확히 밝혀지지 않았습니다.
  4. Images를 수정할 때 이미지의 주소도 실제 환경에 맞게 수정해야 합니다.
  5. style 폴더와 util 폴더의 이름에서 오타가 발견되었습니다. style -> styles, util -> utils로 수정해야 합니다.
  6. 기술 스택에 Next.js가 삭제되었으나, 해당 기술을 사용한 부분이 아직 코드에서 발견되지 않았습니다. 기술 스택 정보와 프로젝트의 기술 스택이 일치하도록 수정이 필요합니다.
  7. 배포 방법에서 npm run start로 프로젝트 실행하는 방식으로 수정되어야 하며, 빌드 및 배포 방법을 추가적으로 다루는 것이 좋습니다. Vercel 대신 Netlify가 언급되어 있는 부분도 수정이 필요합니다.

이러한 사항들을 수정하고 추가 정보를 제공하면 프로젝트의 완성도가 더 높아질 것입니다.

Loading