Conversation
miraclee1226
requested review from
AdamSeungheonShin,
bokeeeey,
cindycho0423 and
dudwns0213
## 워크스루
이 변경 사항은 README.md 파일의 전면적인 개편을 나타냅니다. 기존의 Turborepo 관련 내용이 완전히 제거되고, "Codeit Resources"라는 새로운 프로젝트에 대한 포괄적인 문서로 대체되었습니다. 새로운 문서는 프로젝트의 개요, 팀 구성, 기술 스택, 설치 방법, 기능, 프로젝트 구조 및 도전 과제에 대한 상세한 정보를 제공합니다.
## 변경 사항
| 파일 | 변경 요약 |
|------------|--------------------------------------------------------------------------------------------------------------------|
| README.md | - 전체 내용 교체 <br>- GitHub 배지 추가 <br>- 프로젝트 개요 섹션 생성 <br>- 팀 멤버 테이블 추가 <br>- 기술 스택 설명 포함 <br>- 설치 및 실행 지침 업데이트 <br>- AWS 아키텍처 세부사항 추가 |
## 시퀀스 다이어그램
```mermaid
sequenceDiagram
participant User
participant Platform as Codeit Resources
participant AWS as AWS Services
User->>Platform: 리소스 예약 요청
Platform->>AWS: 리소스 가용성 확인
AWS-->>Platform: 가용성 응답
Platform->>User: 예약 확정토끼의 시
|
🚀 Preview URLBranch: docs-1-readme Preview URL: https://codeit.click?pr=188 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (1)
README.md (1)
201-223: 프로젝트 구조 섹션의 코드 블록 포맷팅이 필요합니다.코드 블록에 언어 지정자를 추가해야 합니다.
다음과 같이 수정해주세요:
- ``` + ```text codeit-resources/ # Project Root ├── apps/🧰 Tools
🪛 Markdownlint (0.37.0)
201-201: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
README.md
112-112: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
116-116: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
125-125: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
133-133: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
137-137: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
141-141: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
145-145: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
227-227: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
231-231: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
201-201: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
5-5: null
No empty links
(MD042, no-empty-links)
6-6: null
No empty links
(MD042, no-empty-links)
7-7: null
No empty links
(MD042, no-empty-links)
8-8: null
No empty links
(MD042, no-empty-links)
2-2: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
46-46: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
51-51: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
56-56: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
61-61: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
66-66: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
114-114: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
118-118: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
119-119: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
120-120: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
121-121: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
122-122: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
123-123: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
127-127: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
135-135: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
139-139: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
143-143: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
147-147: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
236-236: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (2)
README.md (2)
29-35: Overview 섹션이 명확하고 잘 작성되었습니다.프로젝트의 목적과 주요 기능이 간단명료하게 설명되어 있습니다.
239-240: Challenges 섹션 작성이 필요합니다.현재 "추가 예정"으로 표시된 Challenges 섹션의 내용을 작성해주세요. 프로젝트 진행 중 겪은 주요 기술적 도전 과제들과 해결 방법을 포함하면 좋을 것 같습니다.
README.md
Outdated
| ### Architecture | ||
| **1. Web / Mobile** | ||
| - AWS S3에 빌드된 정적 파일을 저장하고, 이를 AWS CloudFront를 통해 배포히였습니다. | ||
| - React Native Webview를 사용하여 Next.js로 만든 웹을 모바일 앱 내에 표시하였습니다. | ||
|
|
||
| **2. Backend** | ||
| - AWS EC2 인스턴스에서 Express.js 서버를 실행한 뒤, MongoDB 데이터베이스와 연동하였습니다. | ||
| - AWS S3를 이용하여 이미지를 저장하였습니다. | ||
|
|
||
| <div align="center"> | ||
| <img src="https://github.com/user-attachments/assets/0a76d65a-1662-4843-a3a2-37791ac55a53" width="800px" /> | ||
| </div> |
There was a problem hiding this comment.
🛠️ Refactor suggestion
아키텍처 섹션의 오타와 마크다운 형식을 수정해야 합니다.
- "배포히였습니다" -> "배포하였습니다" 오타를 수정해야 합니다.
- 볼드체 대신 적절한 헤딩을 사용해야 합니다.
다음과 같이 수정해주세요:
- **1. Web / Mobile**
+ ### 1. Web / Mobile
- - AWS S3에 빌드된 정적 파일을 저장하고, 이를 AWS CloudFront를 통해 배포히였습니다.
+ - AWS S3에 빌드된 정적 파일을 저장하고, 이를 AWS CloudFront를 통해 배포하였습니다.
- **2. Backend**
+ ### 2. Backend📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Architecture | |
| **1. Web / Mobile** | |
| - AWS S3에 빌드된 정적 파일을 저장하고, 이를 AWS CloudFront를 통해 배포히였습니다. | |
| - React Native Webview를 사용하여 Next.js로 만든 웹을 모바일 앱 내에 표시하였습니다. | |
| **2. Backend** | |
| - AWS EC2 인스턴스에서 Express.js 서버를 실행한 뒤, MongoDB 데이터베이스와 연동하였습니다. | |
| - AWS S3를 이용하여 이미지를 저장하였습니다. | |
| <div align="center"> | |
| <img src="https://github.com/user-attachments/assets/0a76d65a-1662-4843-a3a2-37791ac55a53" width="800px" /> | |
| </div> | |
| ### Architecture | |
| ### 1. Web / Mobile | |
| - AWS S3에 빌드된 정적 파일을 저장하고, 이를 AWS CloudFront를 통해 배포하였습니다. | |
| - React Native Webview를 사용하여 Next.js로 만든 웹을 모바일 앱 내에 표시하였습니다. | |
| ### 2. Backend | |
| - AWS EC2 인스턴스에서 Express.js 서버를 실행한 뒤, MongoDB 데이터베이스와 연동하였습니다. | |
| - AWS S3를 이용하여 이미지를 저장하였습니다. | |
| <div align="center"> | |
| <img src="https://github.com/user-attachments/assets/0a76d65a-1662-4843-a3a2-37791ac55a53" width="800px" /> | |
| </div> |
🧰 Tools
🪛 Markdownlint (0.37.0)
227-227: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
231-231: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
236-236: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
| <img src="https://github.com/user-attachments/assets/38a66efd-c2c1-4b87-8a5a-497605a72ad3" width="100px" height="100px" /> | ||
| <h1>Codeit Resources</h1> | ||
|
|
||
| []() | ||
| []() | ||
| []() | ||
| []() | ||
|
|
||
| 사내 리소스 예약, 대여, 반납 플랫폼 | ||
|
|
||
| ❗**GIF 추가 예정** | ||
|
|
||
| </div> | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
헤더 섹션의 접근성 및 링크 개선이 필요합니다.
- GitHub 배지의 빈 링크를 실제 URL로 업데이트해야 합니다.
- 이미지에 대체 텍스트(alt text)를 추가하여 접근성을 개선해야 합니다.
다음과 같이 수정해주세요:
- <img src="https://github.com/user-attachments/assets/38a66efd-c2c1-4b87-8a5a-497605a72ad3" width="100px" height="100px" />
+ <img src="https://github.com/user-attachments/assets/38a66efd-c2c1-4b87-8a5a-497605a72ad3" width="100px" height="100px" alt="Codeit Resources 로고" />
- []()
+ [](https://github.com/codeit-internship-group-b/codeit-resources/issues)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <div align="center"> | |
| <img src="https://github.com/user-attachments/assets/38a66efd-c2c1-4b87-8a5a-497605a72ad3" width="100px" height="100px" /> | |
| <h1>Codeit Resources</h1> | |
| []() | |
| []() | |
| []() | |
| []() | |
| 사내 리소스 예약, 대여, 반납 플랫폼 | |
| ❗**GIF 추가 예정** | |
| </div> | |
| <div align="center"> | |
| <img src="https://github.com/user-attachments/assets/38a66efd-c2c1-4b87-8a5a-497605a72ad3" width="100px" height="100px" alt="Codeit Resources 로고" /> | |
| <h1>Codeit Resources</h1> | |
| [](https://github.com/codeit-internship-group-b/codeit-resources/issues) | |
| []() | |
| []() | |
| []() | |
| 사내 리소스 예약, 대여, 반납 플랫폼 | |
| ❗**GIF 추가 예정** | |
| </div> |
🧰 Tools
🪛 Markdownlint (0.37.0)
5-5: null
No empty links
(MD042, no-empty-links)
6-6: null
No empty links
(MD042, no-empty-links)
7-7: null
No empty links
(MD042, no-empty-links)
8-8: null
No empty links
(MD042, no-empty-links)
2-2: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
|
|
||
| <table align="center"> | ||
| <tbody> | ||
| <tr> | ||
| <td> | ||
| <a href="https://github.com/miraclee1226"> | ||
| <img src="https://avatars.githubusercontent.com/miraclee1226" width="100" height="100"/> | ||
| </a> | ||
| </td> | ||
| <td> | ||
| <a href="https://github.com/bokeeeey"> | ||
| <img src="https://avatars.githubusercontent.com/bokeeeey" width="100" height="100"/> | ||
| </a> | ||
| </td> | ||
| <td> | ||
| <a href="https://github.com/AdamSeungheonShin"> | ||
| <img src="https://avatars.githubusercontent.com/AdamSeungheonShin" width="100px" height="100px"/> | ||
| </a> | ||
| </td> | ||
| <td> | ||
| <a href="https://github.com/cindycho0423"> | ||
| <img src="https://avatars.githubusercontent.com/cindycho0423" width="100px" height="100px"/> | ||
| </a> | ||
| </td> | ||
| <td> | ||
| <a href="https://github.com/dudwns0213"> | ||
| <img src="https://avatars.githubusercontent.com/dudwns0213" width="100px" height="100px"/> | ||
| </a> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <th> | ||
| <a href="https://github.com/miraclee1226">소혜린</a> | ||
| </th> | ||
| <th> | ||
| <a href="https://github.com/bokeeeey">김보경</a> | ||
| </th> | ||
| <th> | ||
| <a href="https://github.com/AdamSeungheonShin">신승헌</a> | ||
| </th> | ||
| <th> | ||
| <a href="https://github.com/cindycho0423">조현지</a> | ||
| </th> | ||
| <th> | ||
| <a href="https://github.com/dudwns0213">배영준</a> | ||
| </th> | ||
| </tr> | ||
| <tr> | ||
| <th> | ||
| FullStack, PM | ||
| </th> | ||
| <th> | ||
| FullStack | ||
| </th> | ||
| <th> | ||
| FullStack | ||
| </th> | ||
| <th> | ||
| FrontEnd | ||
| </th> | ||
| <th> | ||
| FrontEnd | ||
| </th> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
팀 섹션의 접근성 개선이 필요합니다.
프로필 이미지에 대체 텍스트를 추가하여 접근성을 개선해야 합니다.
다음과 같이 수정해주세요:
- <img src="https://avatars.githubusercontent.com/miraclee1226" width="100" height="100"/>
+ <img src="https://avatars.githubusercontent.com/miraclee1226" width="100" height="100" alt="소혜린의 GitHub 프로필 사진"/>각 팀원의 프로필 이미지에 대해 동일한 패턴으로 적용해주세요.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## 👥 Team | |
| <table align="center"> | |
| <tbody> | |
| <tr> | |
| <td> | |
| <a href="https://github.com/miraclee1226"> | |
| <img src="https://avatars.githubusercontent.com/miraclee1226" width="100" height="100"/> | |
| </a> | |
| </td> | |
| <td> | |
| <a href="https://github.com/bokeeeey"> | |
| <img src="https://avatars.githubusercontent.com/bokeeeey" width="100" height="100"/> | |
| </a> | |
| </td> | |
| <td> | |
| <a href="https://github.com/AdamSeungheonShin"> | |
| <img src="https://avatars.githubusercontent.com/AdamSeungheonShin" width="100px" height="100px"/> | |
| </a> | |
| </td> | |
| <td> | |
| <a href="https://github.com/cindycho0423"> | |
| <img src="https://avatars.githubusercontent.com/cindycho0423" width="100px" height="100px"/> | |
| </a> | |
| </td> | |
| <td> | |
| <a href="https://github.com/dudwns0213"> | |
| <img src="https://avatars.githubusercontent.com/dudwns0213" width="100px" height="100px"/> | |
| </a> | |
| </td> | |
| </tr> | |
| <tr> | |
| <th> | |
| <a href="https://github.com/miraclee1226">소혜린</a> | |
| </th> | |
| <th> | |
| <a href="https://github.com/bokeeeey">김보경</a> | |
| </th> | |
| <th> | |
| <a href="https://github.com/AdamSeungheonShin">신승헌</a> | |
| </th> | |
| <th> | |
| <a href="https://github.com/cindycho0423">조현지</a> | |
| </th> | |
| <th> | |
| <a href="https://github.com/dudwns0213">배영준</a> | |
| </th> | |
| </tr> | |
| <tr> | |
| <th> | |
| FullStack, PM | |
| </th> | |
| <th> | |
| FullStack | |
| </th> | |
| <th> | |
| FullStack | |
| </th> | |
| <th> | |
| FrontEnd | |
| </th> | |
| <th> | |
| FrontEnd | |
| </th> | |
| </tr> | |
| </tbody> | |
| </table> | |
| ## 👥 Team | |
| <table align="center"> | |
| <tbody> | |
| <tr> | |
| <td> | |
| <a href="https://github.com/miraclee1226"> | |
| <img src="https://avatars.githubusercontent.com/miraclee1226" width="100" height="100" alt="소혜린의 GitHub 프로필 사진"/> | |
| </a> | |
| </td> | |
| <td> | |
| <a href="https://github.com/bokeeeey"> | |
| <img src="https://avatars.githubusercontent.com/bokeeeey" width="100" height="100" alt="김보경의 GitHub 프로필 사진"/> | |
| </a> | |
| </td> | |
| <td> | |
| <a href="https://github.com/AdamSeungheonShin"> | |
| <img src="https://avatars.githubusercontent.com/AdamSeungheonShin" width="100px" height="100px" alt="신승헌의 GitHub 프로필 사진"/> | |
| </a> | |
| </td> | |
| <td> | |
| <a href="https://github.com/cindycho0423"> | |
| <img src="https://avatars.githubusercontent.com/cindycho0423" width="100px" height="100px" alt="조현지의 GitHub 프로필 사진"/> | |
| </a> | |
| </td> | |
| <td> | |
| <a href="https://github.com/dudwns0213"> | |
| <img src="https://avatars.githubusercontent.com/dudwns0213" width="100px" height="100px" alt="배영준의 GitHub 프로필 사진"/> | |
| </a> | |
| </td> | |
| </tr> | |
| <tr> | |
| <th> | |
| <a href="https://github.com/miraclee1226">소혜린</a> | |
| </th> | |
| <th> | |
| <a href="https://github.com/bokeeeey">김보경</a> | |
| </th> | |
| <th> | |
| <a href="https://github.com/AdamSeungheonShin">신승헌</a> | |
| </th> | |
| <th> | |
| <a href="https://github.com/cindycho0423">조현지</a> | |
| </th> | |
| <th> | |
| <a href="https://github.com/dudwns0213">배영준</a> | |
| </th> | |
| </tr> | |
| <tr> | |
| <th> | |
| FullStack, PM | |
| </th> | |
| <th> | |
| FullStack | |
| </th> | |
| <th> | |
| FullStack | |
| </th> | |
| <th> | |
| FrontEnd | |
| </th> | |
| <th> | |
| FrontEnd | |
| </th> | |
| </tr> | |
| </tbody> | |
| </table> |
🧰 Tools
🪛 Markdownlint (0.37.0)
46-46: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
51-51: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
56-56: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
61-61: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
66-66: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
|
|
||
| ### 1. Frontend | ||
| - **Language** | ||
|
|
||
| <img src="https://img.shields.io/badge/javascript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black"> | ||
|
|
||
| - **Library & Framework** | ||
|
|
||
| <img src="https://img.shields.io/badge/Next.js-black?style=for-the-badge&logo=next.js&logoColor=white"> | ||
| <img src="https://img.shields.io/badge/Tailwind%20CSS-38bdf8?style=for-the-badge&logo=tailwindcss&logoColor=white"> | ||
| <img src="https://img.shields.io/badge/TanStack%20Query-ff5a1f?style=for-the-badge&logo=react-query&logoColor=white"> | ||
| <img src="https://img.shields.io/badge/Storybook-ff4785?style=for-the-badge&logo=storybook&logoColor=white"> | ||
| <img src="https://img.shields.io/badge/Zustand-1c6c7e?style=for-the-badge&logo=zustand&logoColor=white"> | ||
| <img src="https://img.shields.io/badge/React%20Hook%20Form-61dafb?style=for-the-badge&logo=react-hook-form&logoColor=black"> | ||
|
|
||
| - **Deploy** | ||
|
|
||
| <img src="https://img.shields.io/badge/AWS%20S3-232f3e?style=for-the-badge&logo=amazon-s3&logoColor=white"> | ||
| <img src="https://img.shields.io/badge/AWS%20CloudFront-ff9900?style=for-the-badge&logo=aws&logoColor=white"> | ||
|
|
||
| ### 2. Mobile❗**진행중** | ||
|
|
||
| ### 3. Backend | ||
| - **Language** | ||
|
|
||
| <img src="https://img.shields.io/badge/javascript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black"> | ||
|
|
||
| - **Library & Framework** | ||
|
|
||
| <img src="https://img.shields.io/badge/express-000000?style=for-the-badge&logo=express&logoColor=white"> | ||
|
|
||
| - **Database** | ||
|
|
||
| <img src="https://img.shields.io/badge/mongoDB-47A248?style=for-the-badge&logo=MongoDB&logoColor=white"> | ||
|
|
||
| - **Deploy** | ||
|
|
||
| <img src="https://img.shields.io/badge/AWS%20EC2-ff9900?style=for-the-badge&logo=amazon-ec2&logoColor=white"> | ||
|
|
||
| <br /> |
There was a problem hiding this comment.
🛠️ Refactor suggestion
기술 스택 섹션의 접근성 및 일관성 개선이 필요합니다.
- 기술 스택 뱃지에 대체 텍스트를 추가해야 합니다.
- 들여쓰기가 일관되지 않습니다.
다음과 같이 수정해주세요:
- <img src="https://img.shields.io/badge/javascript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black">
+ <img src="https://img.shields.io/badge/javascript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black" alt="JavaScript">
- ### 2. Mobile❗**진행중**
+ ### 2. Mobile
+ ❗**진행중**📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## 🛠️ Tech stack | |
| ### 1. Frontend | |
| - **Language** | |
| <img src="https://img.shields.io/badge/javascript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black"> | |
| - **Library & Framework** | |
| <img src="https://img.shields.io/badge/Next.js-black?style=for-the-badge&logo=next.js&logoColor=white"> | |
| <img src="https://img.shields.io/badge/Tailwind%20CSS-38bdf8?style=for-the-badge&logo=tailwindcss&logoColor=white"> | |
| <img src="https://img.shields.io/badge/TanStack%20Query-ff5a1f?style=for-the-badge&logo=react-query&logoColor=white"> | |
| <img src="https://img.shields.io/badge/Storybook-ff4785?style=for-the-badge&logo=storybook&logoColor=white"> | |
| <img src="https://img.shields.io/badge/Zustand-1c6c7e?style=for-the-badge&logo=zustand&logoColor=white"> | |
| <img src="https://img.shields.io/badge/React%20Hook%20Form-61dafb?style=for-the-badge&logo=react-hook-form&logoColor=black"> | |
| - **Deploy** | |
| <img src="https://img.shields.io/badge/AWS%20S3-232f3e?style=for-the-badge&logo=amazon-s3&logoColor=white"> | |
| <img src="https://img.shields.io/badge/AWS%20CloudFront-ff9900?style=for-the-badge&logo=aws&logoColor=white"> | |
| ### 2. Mobile❗**진행중** | |
| ### 3. Backend | |
| - **Language** | |
| <img src="https://img.shields.io/badge/javascript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black"> | |
| - **Library & Framework** | |
| <img src="https://img.shields.io/badge/express-000000?style=for-the-badge&logo=express&logoColor=white"> | |
| - **Database** | |
| <img src="https://img.shields.io/badge/mongoDB-47A248?style=for-the-badge&logo=MongoDB&logoColor=white"> | |
| - **Deploy** | |
| <img src="https://img.shields.io/badge/AWS%20EC2-ff9900?style=for-the-badge&logo=amazon-ec2&logoColor=white"> | |
| ## 🛠️ Tech stack | |
| ### 1. Frontend | |
| - **Language** | |
| <img src="https://img.shields.io/badge/javascript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black" alt="JavaScript"> | |
| - **Library & Framework** | |
| <img src="https://img.shields.io/badge/Next.js-black?style=for-the-badge&logo=next.js&logoColor=white" alt="Next.js"> | |
| <img src="https://img.shields.io/badge/Tailwind%20CSS-38bdf8?style=for-the-badge&logo=tailwindcss&logoColor=white" alt="Tailwind CSS"> | |
| <img src="https://img.shields.io/badge/TanStack%20Query-ff5a1f?style=for-the-badge&logo=react-query&logoColor=white" alt="TanStack Query"> | |
| <img src="https://img.shields.io/badge/Storybook-ff4785?style=for-the-badge&logo=storybook&logoColor=white" alt="Storybook"> | |
| <img src="https://img.shields.io/badge/Zustand-1c6c7e?style=for-the-badge&logo=zustand&logoColor=white" alt="Zustand"> | |
| <img src="https://img.shields.io/badge/React%20Hook%20Form-61dafb?style=for-the-badge&logo=react-hook-form&logoColor=black" alt="React Hook Form"> | |
| - **Deploy** | |
| <img src="https://img.shields.io/badge/AWS%20S3-232f3e?style=for-the-badge&logo=amazon-s3&logoColor=white" alt="AWS S3"> | |
| <img src="https://img.shields.io/badge/AWS%20CloudFront-ff9900?style=for-the-badge&logo=aws&logoColor=white" alt="AWS CloudFront"> | |
| ### 2. Mobile | |
| ❗**진행중** | |
| ### 3. Backend | |
| - **Language** | |
| <img src="https://img.shields.io/badge/javascript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black" alt="JavaScript"> | |
| - **Library & Framework** | |
| <img src="https://img.shields.io/badge/express-000000?style=for-the-badge&logo=express&logoColor=white" alt="Express"> | |
| - **Database** | |
| <img src="https://img.shields.io/badge/mongoDB-47A248?style=for-the-badge&logo=MongoDB&logoColor=white" alt="MongoDB"> | |
| - **Deploy** | |
| <img src="https://img.shields.io/badge/AWS%20EC2-ff9900?style=for-the-badge&logo=amazon-ec2&logoColor=white" alt="AWS EC2"> |
🧰 Tools
🪛 Markdownlint (0.37.0)
112-112: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
116-116: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
125-125: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
133-133: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
137-137: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
141-141: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
145-145: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
114-114: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
118-118: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
119-119: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
120-120: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
121-121: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
122-122: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
123-123: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
127-127: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
135-135: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
139-139: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
143-143: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
147-147: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
- 오타수정 - pnpm build -> pnpm run build로 수정정
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
226-226: 코드 블록에 언어 지정이 필요합니다.프로젝트 구조를 보여주는 코드 블록에 언어를 지정해주세요:
- ``` + ```text🧰 Tools
🪛 Markdownlint (0.37.0)
226-226: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
README.md
253-253: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
258-258: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
226-226: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
5-5: null
No empty links
(MD042, no-empty-links)
6-6: null
No empty links
(MD042, no-empty-links)
7-7: null
No empty links
(MD042, no-empty-links)
8-8: null
No empty links
(MD042, no-empty-links)
2-2: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
47-47: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
52-52: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
57-57: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
62-62: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
67-67: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
116-116: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
120-120: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
121-121: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
122-122: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
123-123: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
124-124: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
125-125: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
129-129: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
130-130: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
138-138: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
142-142: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
146-146: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
150-150: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
264-264: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: preview
🔇 Additional comments (3)
README.md (3)
1-14: 🛠️ Refactor suggestion헤더 섹션의 접근성 및 링크 개선이 필요합니다.
- 로고 이미지와 GitHub 배지에 대체 텍스트가 누락되었습니다.
- GitHub 배지의 링크가 비어있습니다.
다음과 같이 수정해주세요:
- <img src="https://github.com/user-attachments/assets/38a66efd-c2c1-4b87-8a5a-497605a72ad3" width="100px" height="100px" /> + <img src="https://github.com/user-attachments/assets/38a66efd-c2c1-4b87-8a5a-497605a72ad3" width="100px" height="100px" alt="Codeit Resources 로고" /> - []() + [](https://github.com/codeit-internship-group-b/codeit-resources/issues)나머지 GitHub 배지들도 동일한 패턴으로 수정해주세요.
Likely invalid or redundant comment.
🧰 Tools
🪛 Markdownlint (0.37.0)
5-5: null
No empty links(MD042, no-empty-links)
6-6: null
No empty links(MD042, no-empty-links)
7-7: null
No empty links(MD042, no-empty-links)
8-8: null
No empty links(MD042, no-empty-links)
2-2: null
Images should have alternate text (alt text)(MD045, no-alt-text)
110-151: 🛠️ Refactor suggestion기술 스택 섹션의 접근성 및 일관성 개선이 필요합니다.
- 모든 기술 스택 뱃지에 대체 텍스트가 누락되었습니다.
- Mobile 섹션의 제목 스타일이 일관성이 없습니다.
다음과 같이 수정해주세요:
- <img src="https://img.shields.io/badge/javascript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black"> + <img src="https://img.shields.io/badge/javascript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black" alt="JavaScript"> - ### 2. Mobile❗**진행중** + ### 2. Mobile + ❗**진행중**나머지 기술 스택 뱃지들도 동일한 패턴으로 수정해주세요.
Likely invalid or redundant comment.
🧰 Tools
🪛 Markdownlint (0.37.0)
116-116: null
Images should have alternate text (alt text)(MD045, no-alt-text)
120-120: null
Images should have alternate text (alt text)(MD045, no-alt-text)
121-121: null
Images should have alternate text (alt text)(MD045, no-alt-text)
122-122: null
Images should have alternate text (alt text)(MD045, no-alt-text)
123-123: null
Images should have alternate text (alt text)(MD045, no-alt-text)
124-124: null
Images should have alternate text (alt text)(MD045, no-alt-text)
125-125: null
Images should have alternate text (alt text)(MD045, no-alt-text)
129-129: null
Images should have alternate text (alt text)(MD045, no-alt-text)
130-130: null
Images should have alternate text (alt text)(MD045, no-alt-text)
138-138: null
Images should have alternate text (alt text)(MD045, no-alt-text)
142-142: null
Images should have alternate text (alt text)(MD045, no-alt-text)
146-146: null
Images should have alternate text (alt text)(MD045, no-alt-text)
150-150: null
Images should have alternate text (alt text)(MD045, no-alt-text)
40-106: 🛠️ Refactor suggestion팀 섹션의 접근성 개선이 필요합니다.
각 팀원의 프로필 이미지에 대체 텍스트가 누락되었습니다. 다음과 같이 수정해주세요:
- <img src="https://avatars.githubusercontent.com/miraclee1226" width="100" height="100"/> + <img src="https://avatars.githubusercontent.com/miraclee1226" width="100" height="100" alt="소혜린의 GitHub 프로필 사진"/>나머지 팀원들의 프로필 이미지도 동일한 패턴으로 수정해주세요.
Likely invalid or redundant comment.
🧰 Tools
🪛 Markdownlint (0.37.0)
47-47: null
Images should have alternate text (alt text)(MD045, no-alt-text)
52-52: null
Images should have alternate text (alt text)(MD045, no-alt-text)
57-57: null
Images should have alternate text (alt text)(MD045, no-alt-text)
62-62: null
Images should have alternate text (alt text)(MD045, no-alt-text)
67-67: null
Images should have alternate text (alt text)(MD045, no-alt-text)
README.md
Outdated
| ### Architecture | ||
|
|
||
| **1. Web / Mobile** | ||
|
|
||
| - AWS S3에 빌드된 정적 파일을 저장하고, 이를 AWS CloudFront를 통해 배포하였습니다. | ||
| - React Native Webview를 사용하여 Next.js로 만든 웹을 모바일 앱 내에 표시하였습니다. | ||
|
|
||
| **2. Backend** | ||
|
|
||
| - AWS EC2 인스턴스에서 Express.js 서버를 실행한 뒤, MongoDB 데이터베이스와 연동하였습니다. | ||
| - AWS S3를 이용하여 이미지를 저장하였습니다. | ||
|
|
||
| <div align="center"> | ||
| <img src="https://github.com/user-attachments/assets/0a76d65a-1662-4843-a3a2-37791ac55a53" width="800px" /> | ||
| </div> |
There was a problem hiding this comment.
🛠️ Refactor suggestion
아키텍처 섹션의 개선이 필요합니다.
- 헤딩 스타일이 일관성이 없습니다.
- 아키텍처 다이어그램 이미지에 대체 텍스트가 누락되었습니다.
다음과 같이 수정해주세요:
- **1. Web / Mobile**
+ ### 1. Web / Mobile
- **2. Backend**
+ ### 2. Backend
- <img src="https://github.com/user-attachments/assets/0a76d65a-1662-4843-a3a2-37791ac55a53" width="800px" />
+ <img src="https://github.com/user-attachments/assets/0a76d65a-1662-4843-a3a2-37791ac55a53" width="800px" alt="Codeit Resources 시스템 아키텍처 다이어그램" />📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Architecture | |
| **1. Web / Mobile** | |
| - AWS S3에 빌드된 정적 파일을 저장하고, 이를 AWS CloudFront를 통해 배포하였습니다. | |
| - React Native Webview를 사용하여 Next.js로 만든 웹을 모바일 앱 내에 표시하였습니다. | |
| **2. Backend** | |
| - AWS EC2 인스턴스에서 Express.js 서버를 실행한 뒤, MongoDB 데이터베이스와 연동하였습니다. | |
| - AWS S3를 이용하여 이미지를 저장하였습니다. | |
| <div align="center"> | |
| <img src="https://github.com/user-attachments/assets/0a76d65a-1662-4843-a3a2-37791ac55a53" width="800px" /> | |
| </div> | |
| ### Architecture | |
| ### 1. Web / Mobile | |
| - AWS S3에 빌드된 정적 파일을 저장하고, 이를 AWS CloudFront를 통해 배포하였습니다. | |
| - React Native Webview를 사용하여 Next.js로 만든 웹을 모바일 앱 내에 표시하였습니다. | |
| ### 2. Backend | |
| - AWS EC2 인스턴스에서 Express.js 서버를 실행한 뒤, MongoDB 데이터베이스와 연동하였습니다. | |
| - AWS S3를 이용하여 이미지를 저장하였습니다. | |
| <div align="center"> | |
| <img src="https://github.com/user-attachments/assets/0a76d65a-1662-4843-a3a2-37791ac55a53" width="800px" alt="Codeit Resources 시스템 아키텍처 다이어그램" /> | |
| </div> |
🧰 Tools
🪛 Markdownlint (0.37.0)
253-253: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
258-258: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
264-264: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
README.md (3)
137-137: 모바일 섹션의 형식을 개선해야 합니다."진행중" 표시가 헤더와 같은 줄에 있어 가독성이 떨어집니다.
다음과 같이 수정해주세요:
-### 2. Mobile❗진행중 +### 2. Mobile +❗**진행중**
262-269: 아키텍처 섹션의 헤딩 스타일을 통일해야 합니다.볼드체로 된 헤딩을 마크다운 헤딩 형식으로 변경하여 일관성을 유지해야 합니다.
다음과 같이 수정해주세요:
-**1. Web / Mobile** +### 1. Web / Mobile -**2. Backend** +### 2. Backend🧰 Tools
🪛 Markdownlint (0.37.0)
262-262: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
267-267: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
235-257: 프로젝트 구조 코드 블록에 언어 식별자를 추가해야 합니다.코드 블록의 구문 강조를 위해 언어 식별자를 추가해야 합니다.
다음과 같이 수정해주세요:
-``` +```text codeit-resources/ # Project Root ├── apps/ ...🧰 Tools
🪛 Markdownlint (0.37.0)
235-235: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
README.md
262-262: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
267-267: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
235-235: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
5-5: null
No empty links
(MD042, no-empty-links)
6-6: null
No empty links
(MD042, no-empty-links)
7-7: null
No empty links
(MD042, no-empty-links)
8-8: null
No empty links
(MD042, no-empty-links)
2-2: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
52-52: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
57-57: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
62-62: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
67-67: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
72-72: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
121-121: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
125-125: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
126-126: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
127-127: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
129-129: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
130-130: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
134-134: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
135-135: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
143-143: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
147-147: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
151-151: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
155-155: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
159-159: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
273-273: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (4)
README.md (4)
1-2: 🛠️ Refactor suggestion로고 이미지에 대체 텍스트를 추가해야 합니다.
접근성 향상을 위해 로고 이미지에 대체 텍스트를 추가해야 합니다.
다음과 같이 수정해주세요:
-<img src="https://github.com/user-attachments/assets/38a66efd-c2c1-4b87-8a5a-497605a72ad3" width="100px" height="100px" /> +<img src="https://github.com/user-attachments/assets/38a66efd-c2c1-4b87-8a5a-497605a72ad3" width="100px" height="100px" alt="Codeit Resources 로고" />Likely invalid or redundant comment.
🧰 Tools
🪛 Markdownlint (0.37.0)
2-2: null
Images should have alternate text (alt text)(MD045, no-alt-text)
272-274: 🛠️ Refactor suggestion아키텍처 다이어그램에 대체 텍스트를 추가해야 합니다.
접근성 향상을 위해 아키텍처 다이어그램 이미지에 대체 텍스트를 추가해야 합니다.
다음과 같이 수정해주세요:
-<img src="https://github.com/user-attachments/assets/0a76d65a-1662-4843-a3a2-37791ac55a53" width="800px" /> +<img src="https://github.com/user-attachments/assets/0a76d65a-1662-4843-a3a2-37791ac55a53" width="800px" alt="Codeit Resources 시스템 아키텍처 다이어그램" />Likely invalid or redundant comment.
🧰 Tools
🪛 Markdownlint (0.37.0)
273-273: null
Images should have alternate text (alt text)(MD045, no-alt-text)
45-111: 🛠️ Refactor suggestion팀원 프로필 이미지에 대체 텍스트를 추가해야 합니다.
접근성 향상을 위해 각 팀원의 프로필 이미지에 대체 텍스트를 추가해야 합니다.
다음과 같이 각 팀원의 이미지 태그를 수정해주세요:
-<img src="https://avatars.githubusercontent.com/miraclee1226" width="100" height="100"/> +<img src="https://avatars.githubusercontent.com/miraclee1226" width="100" height="100" alt="소혜린의 GitHub 프로필 사진"/> -<img src="https://avatars.githubusercontent.com/bokeeeey" width="100" height="100"/> +<img src="https://avatars.githubusercontent.com/bokeeeey" width="100" height="100" alt="김보경의 GitHub 프로필 사진"/> # 나머지 팀원들의 이미지도 동일한 패턴으로 수정해주세요Likely invalid or redundant comment.
🧰 Tools
🪛 Markdownlint (0.37.0)
52-52: null
Images should have alternate text (alt text)(MD045, no-alt-text)
57-57: null
Images should have alternate text (alt text)(MD045, no-alt-text)
62-62: null
Images should have alternate text (alt text)(MD045, no-alt-text)
67-67: null
Images should have alternate text (alt text)(MD045, no-alt-text)
72-72: null
Images should have alternate text (alt text)(MD045, no-alt-text)
121-159: 🛠️ Refactor suggestion기술 스택 배지에 대체 텍스트를 추가해야 합니다.
접근성 향상을 위해 모든 기술 스택 배지에 대체 텍스트를 추가해야 합니다.
예시:
-<img src="https://img.shields.io/badge/javascript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black"> +<img src="https://img.shields.io/badge/javascript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black" alt="JavaScript"> -<img src="https://img.shields.io/badge/Next.js-black?style=for-the-badge&logo=next.js&logoColor=white"> +<img src="https://img.shields.io/badge/Next.js-black?style=for-the-badge&logo=next.js&logoColor=white" alt="Next.js"> # 나머지 배지들도 동일한 패턴으로 수정해주세요Likely invalid or redundant comment.
🧰 Tools
🪛 Markdownlint (0.37.0)
121-121: null
Images should have alternate text (alt text)(MD045, no-alt-text)
125-125: null
Images should have alternate text (alt text)(MD045, no-alt-text)
126-126: null
Images should have alternate text (alt text)(MD045, no-alt-text)
127-127: null
Images should have alternate text (alt text)(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)(MD045, no-alt-text)
129-129: null
Images should have alternate text (alt text)(MD045, no-alt-text)
130-130: null
Images should have alternate text (alt text)(MD045, no-alt-text)
134-134: null
Images should have alternate text (alt text)(MD045, no-alt-text)
135-135: null
Images should have alternate text (alt text)(MD045, no-alt-text)
143-143: null
Images should have alternate text (alt text)(MD045, no-alt-text)
147-147: null
Images should have alternate text (alt text)(MD045, no-alt-text)
151-151: null
Images should have alternate text (alt text)(MD045, no-alt-text)
155-155: null
Images should have alternate text (alt text)(MD045, no-alt-text)
159-159: null
Images should have alternate text (alt text)(MD045, no-alt-text)
| <div align="center"> | ||
| <img src="https://github.com/user-attachments/assets/38a66efd-c2c1-4b87-8a5a-497605a72ad3" width="100px" height="100px" /> | ||
| <h1>Codeit Resources</h1> | ||
|
|
||
| []() | ||
| []() | ||
| []() | ||
| []() |
There was a problem hiding this comment.
배지 링크를 업데이트해야 합니다.
GitHub 배지의 링크가 비어있습니다. 각 배지를 해당하는 GitHub 페이지로 연결해야 합니다.
다음과 같이 수정해주세요:
-[]()
+[](https://github.com/codeit-internship-group-b/codeit-resources/issues)
-[]()
+[](https://github.com/codeit-internship-group-b/codeit-resources/stargazers)
-[]()
+[](https://github.com/codeit-internship-group-b/codeit-resources/network/members)
-[]()
+[](https://github.com/codeit-internship-group-b/codeit-resources/watchers)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <div align="center"> | |
| <img src="https://github.com/user-attachments/assets/38a66efd-c2c1-4b87-8a5a-497605a72ad3" width="100px" height="100px" /> | |
| <h1>Codeit Resources</h1> | |
| []() | |
| []() | |
| []() | |
| []() | |
| <div align="center"> | |
| <img src="https://github.com/user-attachments/assets/38a66efd-c2c1-4b87-8a5a-497605a72ad3" width="100px" height="100px" /> | |
| <h1>Codeit Resources</h1> | |
| [](https://github.com/codeit-internship-group-b/codeit-resources/issues) | |
| [](https://github.com/codeit-internship-group-b/codeit-resources/stargazers) | |
| [](https://github.com/codeit-internship-group-b/codeit-resources/network/members) | |
| [](https://github.com/codeit-internship-group-b/codeit-resources/watchers) |
🧰 Tools
🪛 Markdownlint (0.37.0)
5-5: null
No empty links
(MD042, no-empty-links)
6-6: null
No empty links
(MD042, no-empty-links)
7-7: null
No empty links
(MD042, no-empty-links)
8-8: null
No empty links
(MD042, no-empty-links)
2-2: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
171-193: 코드 블록에 언어 지정이 필요합니다.프로젝트 구조를 보여주는 코드 블록에 언어가 지정되어 있지 않습니다.
다음과 같이 수정해주세요:
- ``` + ```text🧰 Tools
🪛 Markdownlint (0.37.0)
171-171: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
README.md
357-357: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
198-198: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
203-203: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
171-171: null
Fenced code blocks should have a language specified
(MD040, fenced-code-language)
5-5: null
No empty links
(MD042, no-empty-links)
6-6: null
No empty links
(MD042, no-empty-links)
7-7: null
No empty links
(MD042, no-empty-links)
8-8: null
No empty links
(MD042, no-empty-links)
2-2: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
52-52: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
57-57: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
62-62: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
67-67: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
72-72: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
121-121: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
125-125: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
126-126: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
127-127: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
129-129: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
130-130: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
134-134: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
135-135: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
143-143: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
147-147: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
151-151: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
155-155: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
159-159: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
209-209: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (4)
README.md (4)
1-19: 헤더 섹션의 접근성 및 링크 개선이 필요합니다.이전 리뷰 의견과 동일한 문제가 있습니다.
🧰 Tools
🪛 Markdownlint (0.37.0)
5-5: null
No empty links(MD042, no-empty-links)
6-6: null
No empty links(MD042, no-empty-links)
7-7: null
No empty links(MD042, no-empty-links)
8-8: null
No empty links(MD042, no-empty-links)
2-2: null
Images should have alternate text (alt text)(MD045, no-alt-text)
115-160: 기술 스택 섹션의 접근성 및 일관성 개선이 필요합니다.이전 리뷰 의견과 동일한 문제가 있습니다.
🧰 Tools
🪛 Markdownlint (0.37.0)
121-121: null
Images should have alternate text (alt text)(MD045, no-alt-text)
125-125: null
Images should have alternate text (alt text)(MD045, no-alt-text)
126-126: null
Images should have alternate text (alt text)(MD045, no-alt-text)
127-127: null
Images should have alternate text (alt text)(MD045, no-alt-text)
128-128: null
Images should have alternate text (alt text)(MD045, no-alt-text)
129-129: null
Images should have alternate text (alt text)(MD045, no-alt-text)
130-130: null
Images should have alternate text (alt text)(MD045, no-alt-text)
134-134: null
Images should have alternate text (alt text)(MD045, no-alt-text)
135-135: null
Images should have alternate text (alt text)(MD045, no-alt-text)
143-143: null
Images should have alternate text (alt text)(MD045, no-alt-text)
147-147: null
Images should have alternate text (alt text)(MD045, no-alt-text)
151-151: null
Images should have alternate text (alt text)(MD045, no-alt-text)
155-155: null
Images should have alternate text (alt text)(MD045, no-alt-text)
159-159: null
Images should have alternate text (alt text)(MD045, no-alt-text)
196-210: 아키텍처 섹션의 개선이 필요합니다.이전 리뷰 의견과 동일한 문제가 있습니다.
🧰 Tools
🪛 Markdownlint (0.37.0)
198-198: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
203-203: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
209-209: null
Images should have alternate text (alt text)(MD045, no-alt-text)
345-352: CI/CD 트러블 슈팅 섹션이 미완성입니다.Shell, 메모리 부족, SSH 연결 끊김 섹션이 비어있습니다. 각 문제에 대한 구체적인 설명과 해결 방법을 추가해주세요.
해당 섹션의 내용 작성을 도와드릴까요?
README.md
Outdated
| # 🚀 Installation | ||
|
|
||
| ### 패키지 설치 | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
헤딩 레벨이 올바르지 않습니다.
설치 섹션의 하위 헤딩이 h1에서 h3로 바로 넘어갑니다. 헤딩 레벨은 순차적으로 증가해야 합니다.
다음과 같이 수정해주세요:
- # 🚀 Installation
-
- ### 패키지 설치
+ # 🚀 Installation
+
+ ## 패키지 설치📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # 🚀 Installation | |
| ### 패키지 설치 | |
| # 🚀 Installation | |
| ## 패키지 설치 |
🧰 Tools
🪛 Markdownlint (0.37.0)
357-357: Expected: h2; Actual: h3
Heading levels should only increment by one level at a time
(MD001, heading-increment)
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
README.md (1)
474-493: 🛠️ Refactor suggestion[헤딩 구조] Installation 섹션 하위 헤딩 레벨 일관성 수정 요청
현재 Installation 섹션은 최상위 헤딩(# 🚀 Installation) 아래에 하위 섹션들이###로 작성되어 있습니다. 마크다운 헤딩 레벨은 순차적으로 증가해야 하므로, “패키지 설치”, “개발 모드”, “프로덕션 모드” 등의 하위 섹딩은##로 변경하는 것이 좋습니다.
예시 수정안:- ### 패키지 설치 + ## 패키지 설치 - ### 개발 모드 + ## 개발 모드 - ### 프로덕션 모드 + ## 프로덕션 모드🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
476-476: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3(MD001, heading-increment)
♻️ Duplicate comments (2)
README.md (2)
216-227: 🛠️ Refactor suggestion[마크다운 스타일] 아키텍처 섹션 헤딩 스타일 일관성 개선 필요
아키텍처 섹션에서 "1. Web / Mobile" 같이 굵은 텍스트로 제목을 표시하고 있는데, 마크다운 헤딩(### 1. Web / Mobile)을 사용하는 것이 가독성과 일관성 측면에서 좋습니다.
예시 수정안:- **1. Web / Mobile** + ### 1. Web / Mobile🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
218-218: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
223-223: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
5-8: 🛠️ Refactor suggestion[링크 검증] GitHub 뱃지의 빈 링크 수정 필요
라인 5~8의 각 뱃지에 빈 링크()가 사용되고 있습니다. 배지 클릭 시 해당하는 GitHub 페이지(예: 이슈, 스타, 포크, 워처 등)로 연결되도록 적절한 URL을 추가해주세요.
예시 수정안:-[]() +[](https://github.com/codeit-internship-group-b/codeit-resources/issues)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
5-5: No empty links
null(MD042, no-empty-links)
6-6: No empty links
null(MD042, no-empty-links)
7-7: No empty links
null(MD042, no-empty-links)
8-8: No empty links
null(MD042, no-empty-links)
🧹 Nitpick comments (10)
README.md (10)
1-4: [접근성 개선] 헤더 이미지에 대체 텍스트(alt 속성) 추가 필요
첫 번째<img>태그(라인 2)는 alt 속성이 없어, 스크린 리더 등 접근성 측면에서 불리합니다. 프로젝트 로고나 관련 설명을 담은 alt 텍스트를 추가해주세요.
예시 수정안:- <img src="https://github.com/user-attachments/assets/38a66efd-c2c1-4b87-8a5a-497605a72ad3" width="100px" height="100px" /> + <img src="https://github.com/user-attachments/assets/38a66efd-c2c1-4b87-8a5a-497605a72ad3" width="100px" height="100px" alt="Codeit Resources 로고" />🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
2-2: Images should have alternate text (alt text)
null(MD045, no-alt-text)
107-122: [접근성 개선] 기술 스택(Frontend) 섹션 이미지에 alt 속성 추가 필요
프론트엔드 관련 배지 이미지에도 alt 속성이 누락되어 있습니다. 각 기술의 이름 등 적절한 대체 텍스트를 추가하여 접근성을 개선해주세요.
예시 수정안:- <img src="https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white"> + <img src="https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript&logoColor=white" alt="TypeScript">🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
113-113: Images should have alternate text (alt text)
null(MD045, no-alt-text)
117-117: Images should have alternate text (alt text)
null(MD045, no-alt-text)
118-118: Images should have alternate text (alt text)
null(MD045, no-alt-text)
119-119: Images should have alternate text (alt text)
null(MD045, no-alt-text)
120-120: Images should have alternate text (alt text)
null(MD045, no-alt-text)
121-121: Images should have alternate text (alt text)
null(MD045, no-alt-text)
122-122: Images should have alternate text (alt text)
null(MD045, no-alt-text)
129-137: [접근성 개선] 모바일 섹션 이미지에 alt 속성 추가 필요
모바일 관련 이미지(예: ReactNative (Expo) 배지)에도 대체 텍스트가 없습니다. 기술 이름이나 용도를 설명하는 alt 텍스트를 추가해주세요.
예시 수정안:- <img src="https://img.shields.io/badge/ReactNative (Expo)-222222?style=for-the-badge&logo=React&logoColor="> + <img src="https://img.shields.io/badge/ReactNative (Expo)-222222?style=for-the-badge&logo=React&logoColor=" alt="React Native (Expo)">🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
133-133: Images should have alternate text (alt text)
null(MD045, no-alt-text)
137-137: Images should have alternate text (alt text)
null(MD045, no-alt-text)
139-159: [접근성 개선] 백엔드 및 CI/CD 섹션 이미지에 alt 속성 추가 필요
백엔드(라인 139156)와 CI/CD(라인 157159) 섹션의 각 배지 이미지에도 alt 속성이 누락되어 있습니다. 해당 기술이나 도구의 이름을 포함하는 alt 텍스트를 추가해주세요.
예시 수정안(백엔드 예시):- <img src="https://img.shields.io/badge/express-000000?style=for-the-badge&logo=express&logoColor=white"> + <img src="https://img.shields.io/badge/express-000000?style=for-the-badge&logo=express&logoColor=white" alt="Express.js">🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
143-143: Images should have alternate text (alt text)
null(MD045, no-alt-text)
147-147: Images should have alternate text (alt text)
null(MD045, no-alt-text)
151-151: Images should have alternate text (alt text)
null(MD045, no-alt-text)
155-155: Images should have alternate text (alt text)
null(MD045, no-alt-text)
159-159: Images should have alternate text (alt text)
null(MD045, no-alt-text)
172-214: [문서 개선] 프로젝트 폴더 구조 코드 블록에 언어 지정 요청
프로젝트 구조를 보여주는 코드 블록은 언어가 지정되어 있지 않아 문법 강조 효과를 활용하지 못하고 있습니다. 적절한 언어(예:plaintext또는text)를 지정해주세요.
예시 수정안:- ``` - codeit-resources/ # Project Root - ├── apps/ - │ ├── api/ # 백엔드 서버 - │ │ └── src/ - │ │ ├── controllers/ # API 엔드포인트 핸들러 - │ │ └── ... - ``` + ```plaintext + codeit-resources/ # Project Root + ├── apps/ + │ ├── api/ # 백엔드 서버 + │ │ └── src/ + │ │ ├── controllers/ # API 엔드포인트 핸들러 + │ │ └── ... + ```🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
172-172: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
228-230: [접근성 개선] 아키텍처 다이어그램 이미지에 대체 텍스트 추가 필요
아키텍처 다이어그램을 표시하는<img>태그(라인 229)는 alt 속성이 없습니다. 이미지의 내용을 설명하는 대체 텍스트를 추가해주세요.
예시 수정안:- <img src="https://github.com/user-attachments/assets/0a76d65a-1662-4843-a3a2-37791ac55a53" width="800px" /> + <img src="https://github.com/user-attachments/assets/0a76d65a-1662-4843-a3a2-37791ac55a53" width="800px" alt="Codeit Resources 시스템 아키텍처 다이어그램" />🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
229-229: Images should have alternate text (alt text)
null(MD045, no-alt-text)
254-257: [문서 개선] 코드 블록에 언어 지정 필요 (YAML 예시)
라인 254~257에 있는 코드 블록(예: MongoDB 보안 설정)은 언어 지정이 되어 있지 않습니다.yaml등 적절한 언어를 지정하여 가독성을 높여주세요.
예시 수정안:- ``` - security: - authorization: enabled - ``` + ```yaml + security: + authorization: enabled + ```🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
254-254: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
275-284: [문서 개선] Shell 관련 코드 블록에 언어 지정 필요
라인 275~284의 배포 스크립트 코드 블록은 언어 지정(bash)이 되어 있지 않습니다. 문법 강조를 위해bash를 지정해주세요.
예시 수정안:- ``` - # Add pnpm and pm2 to PATH - export PATH="$PATH:/home/ubuntu/.local/share/pnpm" - - # If not running interactively, don't do anything - case $- in - *i*) ;; - *) return;; - esac - ``` + ```bash + # Add pnpm and pm2 to PATH + export PATH="$PATH:/home/ubuntu/.local/share/pnpm" + + # If not running interactively, don't do anything + case $- in + *i*) ;; + *) return;; + esac + ```
323-353: [문서 개선] Suspense/ErrorBoundary 관련 코드 블록에 언어 지정 필요 (예: TypeScript)
라인 323~353의 코드 블록은 언어 지정이 되어 있지 않아 가독성이 떨어집니다.typescript혹은javascript를 지정하여 문법 강조 효과를 누리세요.
예시 수정안:- ``` - import { useQuery } from 'react-query'; - - const ResponsiveTeamsPage = () => { - const { data, isLoading, isError, error } = useQuery('teams', fetchTeams); - - if (isLoading) { - return ( - <> - <TeamListHeader /> - <TeamListSkeletonGroup /> - </> - ); - } - - if (isError) { - return ( - <> - <TeamListHeader /> - <div>Error occurred: {error.message}</div> - </> - ); - } - - return ( - <> - <TeamListHeader /> - <TeamList data={data} /> - </> - ); - }; - ``` + ```typescript + import { useQuery } from 'react-query'; + + const ResponsiveTeamsPage = () => { + const { data, isLoading, isError, error } = useQuery('teams', fetchTeams); + + if (isLoading) { + return ( + <> + <TeamListHeader /> + <TeamListSkeletonGroup /> + </> + ); + } + + if (isError) { + return ( + <> + <TeamListHeader /> + <div>Error occurred: {error.message}</div> + </> + ); + } + + return ( + <> + <TeamListHeader /> + <TeamList data={data} /> + </> + ); + }; + ```🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
323-323: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
361-373: [문서 개선] Suspense/ErrorBoundary 코드 블록에 언어 지정 필요 (예: TypeScript)
라인 361~373의 코드 블록도 언어 지정이 빠져 있습니다.typescript또는javascript를 지정하여 코드 이해도를 높여주세요.
예시 수정안:- ``` - export default function ResponsiveTeamsPage(): JSX.Element | null { - - return ( - <> - <TeamListHeader /> - <ErrorResetBoundary fallbackComponent={ErrorFallback}> - <Suspense fallback={<TeamListSkeletonGroup />}> - <TeamList /> - </Suspense> - </ErrorResetBoundary> - </> - ); - } - ``` + ```typescript + export default function ResponsiveTeamsPage(): JSX.Element | null { + + return ( + <> + <TeamListHeader /> + <ErrorResetBoundary fallbackComponent={ErrorFallback}> + <Suspense fallback={<TeamListSkeletonGroup />}> + <TeamList /> + </Suspense> + </ErrorResetBoundary> + </> + ); + } + ```
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
2-2: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
5-5: No empty links
null
(MD042, no-empty-links)
6-6: No empty links
null
(MD042, no-empty-links)
7-7: No empty links
null
(MD042, no-empty-links)
8-8: No empty links
null
(MD042, no-empty-links)
43-43: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
48-48: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
53-53: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
58-58: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
63-63: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
113-113: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
117-117: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
118-118: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
119-119: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
120-120: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
121-121: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
122-122: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
126-126: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
127-127: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
133-133: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
137-137: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
143-143: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
147-147: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
151-151: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
155-155: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
159-159: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
172-172: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
218-218: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
223-223: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
229-229: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
254-254: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
310-310: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
323-323: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
360-360: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
476-476: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
🔇 Additional comments (1)
README.md (1)
36-65: [접근성 개선] 팀 섹션 프로필 이미지에 alt 속성 추가 요청
팀 구성원 프로필 이미지는 alt 속성이 없어 접근성이 떨어집니다. 각 이미지에 구성원의 이름이나 “GitHub 프로필 사진” 등의 대체 텍스트를 추가해주세요.
예시 수정안:- <img src="https://avatars.githubusercontent.com/miraclee1226" width="100" height="100"/> + <img src="https://avatars.githubusercontent.com/miraclee1226" width="100" height="100" alt="소혜린의 GitHub 프로필 사진"/>🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
43-43: Images should have alternate text (alt text)
null(MD045, no-alt-text)
48-48: Images should have alternate text (alt text)
null(MD045, no-alt-text)
53-53: Images should have alternate text (alt text)
null(MD045, no-alt-text)
58-58: Images should have alternate text (alt text)
null(MD045, no-alt-text)
63-63: Images should have alternate text (alt text)
null(MD045, no-alt-text)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
README.md (4)
112-121: 프론트엔드 기술 스택 이미지: 대체 텍스트 추가 요청
프론트엔드 섹션에 사용된 기술 뱃지 이미지들에alt속성이 없어, 접근성 향상을 위해 각 이미지에 의미 있는 대체 텍스트(예: “TypeScript”)를 추가할 것을 권장합니다.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
112-112: Images should have alternate text (alt text)
null(MD045, no-alt-text)
116-116: Images should have alternate text (alt text)
null(MD045, no-alt-text)
117-117: Images should have alternate text (alt text)
null(MD045, no-alt-text)
118-118: Images should have alternate text (alt text)
null(MD045, no-alt-text)
119-119: Images should have alternate text (alt text)
null(MD045, no-alt-text)
120-120: Images should have alternate text (alt text)
null(MD045, no-alt-text)
121-121: Images should have alternate text (alt text)
null(MD045, no-alt-text)
132-137: 모바일 섹션: 이미지 및 URL 쿼리 문자열 검토 필요
모바일 섹션의 “라이브러리 & 프레임워크” 부분, 특히 라인 136의 React Native (Expo) 뱃지의 경우alt속성이 누락되었으며,logoColor값이 비어 있습니다. 적절한alt텍스트와 올바른 값 설정을 부탁드립니다.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
132-132: Images should have alternate text (alt text)
null(MD045, no-alt-text)
136-136: Images should have alternate text (alt text)
null(MD045, no-alt-text)
138-159: 백엔드 및 CI/CD 섹션: 이미지 alt 텍스트 추가 요청
백엔드(라인 138156) 및 CI/CD(라인 157159) 섹션에서 사용된 이미지 태그에도alt속성이 누락되어 있습니다. 접근성 및 문서의 일관성을 위해 이미지마다 적절한 대체 텍스트를 추가해 주세요.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
142-142: Images should have alternate text (alt text)
null(MD045, no-alt-text)
146-146: Images should have alternate text (alt text)
null(MD045, no-alt-text)
150-150: Images should have alternate text (alt text)
null(MD045, no-alt-text)
154-154: Images should have alternate text (alt text)
null(MD045, no-alt-text)
158-158: Images should have alternate text (alt text)
null(MD045, no-alt-text)
194-194: 프로젝트 폴더 구조 코드 블록: 언어 식별자 추가 요망
프로젝트 폴더 구조를 나타내는 코드 블록(라인 194)에 언어 식별자가 미지정되어 있습니다. 가독성과 편집기 지원을 위해 적절한 언어(예:bash또는sh)를 명시해 주세요.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
194-194: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
2-2: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
5-5: No empty links
null
(MD042, no-empty-links)
6-6: No empty links
null
(MD042, no-empty-links)
7-7: No empty links
null
(MD042, no-empty-links)
8-8: No empty links
null
(MD042, no-empty-links)
42-42: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
47-47: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
52-52: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
57-57: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
62-62: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
112-112: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
116-116: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
117-117: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
118-118: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
119-119: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
120-120: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
121-121: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
125-125: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
126-126: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
132-132: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
136-136: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
142-142: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
146-146: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
150-150: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
154-154: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
158-158: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
165-165: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3
(MD001, heading-increment)
194-194: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
240-240: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
245-245: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
251-251: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
🔇 Additional comments (5)
README.md (5)
1-9: 헤더 영역: 이미지 대체 텍스트 및 배지 링크 업데이트 필요
라인 2의<img>태그는alt속성이 없어 접근성 측면에서 보완이 필요합니다. 또한, 라인 5~8에 사용된 GitHub 배지의 링크가 비어 있어 실제 페이지로 연결되도록 업데이트해야 합니다.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
2-2: Images should have alternate text (alt text)
null(MD045, no-alt-text)
5-5: No empty links
null(MD042, no-empty-links)
6-6: No empty links
null(MD042, no-empty-links)
7-7: No empty links
null(MD042, no-empty-links)
8-8: No empty links
null(MD042, no-empty-links)
35-102: 팀 섹션: 프로필 이미지 접근성 개선
팀 구성원 프로필 이미지에alt속성이 누락되었습니다. 이전 리뷰에서도 동일하게 지적된 사항이므로, 각 이미지에 “OO님의 GitHub 프로필 사진”과 같이 적절한 대체 텍스트를 추가해 주세요.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
42-42: Images should have alternate text (alt text)
null(MD045, no-alt-text)
47-47: Images should have alternate text (alt text)
null(MD045, no-alt-text)
52-52: Images should have alternate text (alt text)
null(MD045, no-alt-text)
57-57: Images should have alternate text (alt text)
null(MD045, no-alt-text)
62-62: Images should have alternate text (alt text)
null(MD045, no-alt-text)
163-171: Installation 섹션: 헤딩 레벨 수정 필요
Installation 섹션에서 상위 헤딩(# 🚀 Installation) 바로 하위에 h3(### 패키지 설치)가 사용되고 있습니다. 헤딩은 상위 수준에서 한 단계씩 증가하도록 작성하는 것이 좋으므로, 예를 들어 h2를 사용하는 방식으로 수정해 주세요.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
165-165: Heading levels should only increment by one level at a time
Expected: h2; Actual: h3(MD001, heading-increment)
238-253: 아키텍처 섹션: 마크다운 형식 및 이미지 대체 텍스트 개선
아키텍처 섹션에서 ‘1. Web / Mobile’ 및 ‘2. Backend’와 같이 단순 강조 표기를 사용하고 있는데, 보다 적절한 헤딩 태그(예:###)를 사용하여 문서 구조를 개선할 것을 제안합니다. 또한, 라인 251의 중앙 정렬 이미지에도alt속성을 추가해 주세요.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
240-240: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
245-245: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
251-251: Images should have alternate text (alt text)
null(MD045, no-alt-text)
257-341: Features 섹션: 긍정적 검토
Features 섹션은 전반적으로 구성 및 스크린샷에 사용된 대체 텍스트가 적절하게 적용되어 있습니다. 별도의 수정 요청은 없으며, 잘 작성되었습니다.
2 participants
🚀 작업 내용
리드미 작성했습니다. 에러 수정 & 모바일 앱 개발 하면서 같이 디벨롭 할 예정이에요!
리드미 URL -> https://github.com/codeit-internship-group-b/codeit-resources/blob/341696b09d3c7e88ea01163605dfb82a2e576249/README.md
🚨 관련 이슈 (이슈 번호)
✅ 체크리스트
Summary by CodeRabbit
Summary by CodeRabbit
pnpm명령어로 업데이트