Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
37 changes: 21 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@
</div>

## 📝 프로젝트 소개

---
웹에이전시 내에서 계약 단계부터 납품 및 하자보수까지의 과정을 클라이언트와 효율적으로 공유 및 관리할 수 있는 웹 서비스입니다.

### Devlens는!
Expand All @@ -32,20 +30,23 @@ Q. 잠깐! 고객사, 개발사, 관리자가 무엇을 의미하나요?
<br />

### 화면 구성
| Screen #1 | Screen #2 |
|:----------------------------------------------:|:----------------------------------------------:|
| <img src="src/resources/화면1.png" width="400"/> | <img src="src/resources/화면2.png" width="400"/> |
| 프로젝트 생성 페이지 | 권한 부여 페이지 |
| Screen #3 | Screen #4 |
| <img src="src/resources/화면3.png" width="400"/> | <img src="src/resources/화면4.png" width="400"/> |
| 진행 단계 페이지 | 체크리스트 내역 페이지 |
| 사용자 화면 #1 - 메인 대시보드 | 사용자 화면 #2 - 프로젝트 진행 단계 |
|:---------------------------------------------------:|:-----------------------------------------------------:|
| <img src="src/resources/대시보드.png" width="400"/> | <img src="src/resources/프로젝트 진행 단계.png" width="400"/> |
| 사용자 화면 #3 - 체크리스트 내역 | 사용자 화면 #4 - 체크리스트 반려 시 |
| <img src="src/resources/화면4.png" width="400"/> | <img src="src/resources/체크리스트 반려.png" width="400"/> |
| 사용자 화면 #3 - 프로젝트 게시판 | 사용자 화면 #4 - 게시글 상세 |
| <img src="src/resources/프로젝트 게시판.png" width="400"/> | <img src="src/resources/게시글 상세.png" width="400"/> |
| 관리자 화면 #1 -대시보드 | 관리자 화면 #2 - 회사 생성 페이지 |
| <img src="src/resources/관리자_대시보드.png" width="400"/> | <img src="src/resources/회사생성.png" width="400"/> |
| 관리자 화면 #3 - 프로젝트 생성 페이지 | 관리자 화면 #4 - 권한 부여 페이지 |
| <img src="src/resources/화면1.png" width="400"/> | <img src="src/resources/화면2.png" width="400"/> |


<br />

## 📍 주요 기능

---

### <대시보드>
1. 참여한 모든 프로젝트 목록 조회
- 프로젝트 참여자로 지정된 프로젝트만 조회가 가능합니다.
Expand Down Expand Up @@ -151,7 +152,15 @@ Q. 잠깐! 고객사, 개발사, 관리자가 무엇을 의미하나요?

## ⚙ 기술 스택

---
### Front-end
<div>
<img src="src/resources/skill/NextJs.png" width="80">
<img src="src/resources/skill/TypeScript.png" width="80">
<img src="src/resources/skill/TailwindCSS.png" width="80">
<img src="src/resources/skill/ShadcnUI.png" width="80">
<img src="src/resources/skill/Axios.png" width="80">

</div>

### Back-end
<div>
Expand Down Expand Up @@ -184,8 +193,6 @@ Q. 잠깐! 고객사, 개발사, 관리자가 무엇을 의미하나요?

## 🛠️ 프로젝트 아키텍쳐

---

<img src="src/resources/project-architecture.png" width="800">


Expand All @@ -194,8 +201,6 @@ Q. 잠깐! 고객사, 개발사, 관리자가 무엇을 의미하나요?

## 🗂️ 기술 문서

---

👉 **API 명세서** : [바로가기](https://docs.google.com/spreadsheets/d/1PqEn59XP4E7UgQDv9gJ4ZIOBvHWXN_rnXk-Hsugjvgo/edit?gid=1624724435#gid=1624724435)

👉 **기능 명세서** : [바로가기](https://www.notion.so/9dba38c13b88444787a0cae943774bcb?pvs=4)

Choose a reason for hiding this comment

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

코드 패치에 대한 간단한 리뷰를 진행하겠습니다.

변경 사항 요약

  1. 화면 구성이 수정되었습니다.

    • 스크린의 제목과 이미지를 변경하여 각 화면이 누가 사용하는지 명확하게 하였습니다.
    • 추가적으로 몇 개의 화면이 포함되었습니다.
  2. 기술 스택 섹션이 업데이트되었습니다.

    • 프론트엔드 기술 스택이 추가되어 명확하게 기술을 표시하였습니다.
  3. 기술 문서 섹션에서 불필요한 줄이 제거되었습니다.

코드 리뷰

장점

  • 명확성: 화면 구성에 있어 누구의 화면인지 명확하게 표기하여 이해하기 쉬워졌습니다.
  • 기술 스택 추가: 프론트엔드 기술 스택을 상세히 나열해줌으로써 개발 환경에 대한 이해를 높였습니다.

개선 사항 및 잠재적 버그 리스크

  1. 이미지 파일의 경로 검증:

    • 이미지 경로가 잘못되었거나 파일이 존재하지 않을 경우, 사용자에게 빈 화면을 보여줄 수 있습니다. 이미지 파일들이 제대로 배포되고 검증되었는지 확인해야 합니다.
  2. 접근성 고려:

    • 이미지에 alt 속성을 추가하여 접근성을 높일 수 있습니다. 현재 이미지에 대한 설명이 부족합니다. 이는 화면 읽기 도구를 사용하는 사용자에게 도움이 될 수 있습니다.
  3. 문서 구조의 통일성:

    • 문서의 각 섹션 구분선(----) 사용이 일관되지 않으므로, 통일성 있는 구조로 변경할 필요가 있습니다. 예를 들어, 제목과 내용 사이의 구분선 유무가 일관되지 않습니다.
  4. 어려운 점 없도록 배려:

    • "Q. 잠깐! 고객사, 개발사, 관리자가 무엇을 의미하나요?"와 같은 질문이 연속으로 반복되고 있으나, 문서의 흐름을 고려하여 적절한 위치에 배치하는 것도 중요할 것 같습니다. 사용자의 흐름을 고려하여 내용을 배치하는 것이 좋습니다.

결론

전반적으로 유용한 수정을 포함하고 있으며, 명확성과 사용자 이해도를 높이는 방향으로 진행되었습니다. 제안된 개선 사항을 고려하면 코드의 품질과 사용자 경험을 더욱 향상시킬 수 있을 것입니다.

Expand Down
Binary file added src/resources/skill/Axios.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/resources/skill/NextJs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/resources/skill/ShadcnUI.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/resources/skill/TailwindCSS.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/resources/skill/TypeScript.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/resources/게시글 상세.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/resources/관리자_대시보드.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/resources/대시보드.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/resources/체크리스트 반려.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/resources/프로젝트 게시판.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/resources/프로젝트 진행 단계.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/resources/프로젝트_게시판.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/resources/회사생성.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading