Skip to content
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

Jump to bottom

docs: README 업데이트 #86

Merged
merged 6 commits into from
Oct 15, 2024
Merged

docs: README 업데이트 #86

merged 6 commits into from
Oct 15, 2024

Conversation

viaunixue
Copy link
Member

@viaunixue viaunixue commented Oct 12, 2024 •
edited by jira bot
Loading

#️⃣연관된 이슈

CHZZ-138

📝작업 내용

  • 프로젝트 소개 및 배너 추가
  • 데이터베이스 ERD 다이어그램 추가
  • 개발 환경 및 기술 스택 정리
  • API 엔드포인트 표 작성
  • 프로젝트 구조 추가

✅테스트 결과

🙏리뷰 요구사항(선택)

@viaunixue
docs: README 업데이트
80edf6d 
- 프로젝트 소개 및 배너 추가
- 데이터베이스 ERD 다이어그램 추가
- 개발 환경 및 기술 스택 정리
- API 엔드포인트 표 작성
- 프로젝트 구조 추가

#CHZZ-138
@viaunixue viaunixue added the 📃docs 문서 추가 또는 변경 label Oct 12, 2024
@viaunixue viaunixue self-assigned this Oct 12, 2024
@viaunixue
docs: README 업데이트
34b2200 
- 팀원 소개 수정

#CHZZ-138
@viaunixue
docs: README 업데이트
9654323 
- 시스템 아키텍처 소개 수정

#CHZZ-138
junest66
junest66 reviewed Oct 13, 2024
View reviewed changes
Copy link
Collaborator

@junest66 junest66 left a comment

Choose a reason for hiding this comment

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

나중에 스웨거가 나오면 스웨거 링크만 첨부하고 주요 엔드포인트 부분은 삭제하는게 좋을것 같고, 프로젝트 구조도 없는게 더 좋을것같아요 그리고 팀원 github 주소 변경해야할것같습니다!

@viaunixue
docs: README 업데이트
427e5bc 
- 시스템 아키텍처 Draw.io link로 수정
- 기술 스택 프론트엔드, 협업툴 부분 제거
- ERD Mermaid 제거
- API Swagger 링크로 대체
- 프로젝트 구조 제거
- 팀원 소개 링크 수정

#CHZZ-138
junest66
junest66 reviewed Oct 14, 2024
View reviewed changes
Copy link
Collaborator

@junest66 junest66 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

  1. 치즈마켓 사용해보기에 프론트 배포 주소 url 넣어주세요
  2. 일단 API 문서는 빼주실래요 제가 봤을땐 v2만들때 openapi swagger 도입할때 넣으면 될것같아요
  3. 당장은 검색 기능 및 카테고리 관리 부분도 빼주시면 좋을것 같아요
  4. 아키텍쳐 이미지는 최신화해주시면 될것같아요
  5. ERD 사진은 빼는게 좋을 것 같아요!

@viaunixue
docs: README 업데이트
7ed7d61 
- 치즈마켓 배포 주소 url 업데이트
- API 문서 링크 삭제
- 검색 기능 및 카테고리 관리 제거
- 아키텍쳐 이미지 최신화
- ERD 사진 제거

#CHZZ-138
@viaunixue
docs: README 업데이트
8de9e6c 
- 개발 기간 변경

#CHZZ-138
junest66
junest66 approved these changes Oct 15, 2024
View reviewed changes
Copy link
Collaborator

@junest66 junest66 left a comment

Choose a reason for hiding this comment

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

고생하셨습니다!

@junest66 junest66 merged commit ca3ad77 into JECT-Study:develop Oct 15, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@junest66 junest66 junest66 approved these changes

@YeaChan05 YeaChan05 YeaChan05 approved these changes

Assignees

@viaunixue viaunixue

Labels
📃docs 문서 추가 또는 변경
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@viaunixue @YeaChan05 @junest66