Skip to content

Latest commit

 

History

History
230 lines (187 loc) · 4.72 KB

README.md

File metadata and controls

230 lines (187 loc) · 4.72 KB
Raw

KDT5-M6

🤝 검색어 자동완성 사이트 및 소비패턴 기록 서비스 구현, 팀 프로젝트

Calendar & List 등 내가 소비한 금액 및 품목들을 기입하고, 월단위로 얼마를 썼는지, 어떤 항목에 비중을 두었는지 등을 기록하는

웹 서비스를 구현합니다.

웹/모바일웹 구현 모두 무방하며, 다양한 차트를 활용할 수 있습니다.

react를 필수로 사용해야 합니다. 과제 수행 및 리뷰 기간은 별도 공지를 참고하세요!

과제 수행 및 제출 방법

KDT기수번호_이름

E.g, KDT0_BaeJinHo

현재 저장소를 로컬에 클론(Clone)합니다. 자신의 본명으로 브랜치를 생성합니다.(구분 가능하도록 본명을 꼭 파스칼케이스로 표시하세요, git branch KDTX_BaeJinHo) 자신의 본명 브랜치에서 과제를 수행합니다. 과제 수행이 완료되면, 자신의 본명 브랜치를 원격 저장소에 푸시(Push)합니다.(main 브랜치에 푸시하지 않도록 꼭 주의하세요, git push origin KDTX_BaeJinHo) 저장소에서 main 브랜치를 대상으로 Pull Request 생성하면, 과제 제출이 완료됩니다!(E.g, main <== KDTX_BaeJinHo) main 혹은 다른 사람의 브랜치로 절대 병합하지 않도록 주의하세요! Pull Request에서 보이는 설명을 다른 사람들이 이해하기 쉽도록 꼼꼼하게 작성하세요! Pull Request에서 과제 제출 후 절대 병합(Merge)하지 않도록 주의하세요! 과제 수행 및 제출 과정에서 문제가 발생한 경우, 바로 담당 멘토나 강사에서 얘기하세요!

[필수 구현] 지출 내역 입력 폼 (지출 금액, 지출항목, 지출 날짜) 지출 내역 목록(일반 리스트형, 칼렌더 형 표기 가능) 지출 내역 수정 및 삭제

[선택 구현] 지출 내역 칼렌더로 표기 지출 내역 월별 내역, 주별 내역, 일별 내역 표기 차트를 이용해서 소비 내역 표기 하기 모바일 형태로 구현할지, 웹 형태로 구현할지는 자유

URL 예제 : http://52.78.195.183:3003/api/expenses API

  1. 소비 기록 작성 API

description 추가 (선택)

Request:

POST /expenses
Content-Type: application/json

{
  "amount": 100,
  "userId": "user123",
  "category": "food",
  "description": "설명",
  "date": "2023-07-04T10:30:00.000Z"
}

Response:

Status: 201 Created
{
  "message": "Expense created successfully"
}
  1. 소비 품목 목록 API Request:
GET /categories?userId={userId}

Response:

Status: 200 OK

["food", "clothing", "electronics"]
  1. 검색어에 해당하는 소비 항목 및 금액 조회 API

Request:

GET /expenses/search?q={keyword}&userId={userId}

Response:

Status: 200 OK
[
  {
    "amount": 100,
    "userId": "user123",
    "category": "food",
    "date": "2023-07-04T10:30:00.000Z"
  },
  {
    "amount": 80,
    "userId": "user456",
    "category": "food",
    "date": "2023-07-03T14:20:00.000Z"
  }
]
  1. 일별, 주별, 월별 소비 조회 API Request:
(category는 선택)
GET /expenses/summary?period={period}&userId={userId}&category={category}
period : daily, weekly, monthly

Response:

Status: 200 OK
[
  {
    "_id": "2023-07-04",
    "totalAmount": 180
  },
  {
    "_id": "2023-07-03",
    "totalAmount": 80
  }
]
  1. 소비 기록 수정 API Request:
PUT /expenses/123

Content-Type: application/json

{
  "amount": 150,
  "userId": "user123",
  "category": "food",
  "date": "2023-07-04T10:30:00.000Z"
}

Response:

Status: 200 OK
{
  "message": "Expense updated successfully"
}
  1. 소비 기록 삭제 API Request:
DELETE /expenses/123

Response:

Status: 200 OK
{
  "message": "Expense deleted successfully"
}
  1. 소비 기록 달력 호출 API Request:
(category는 선택)
GET /expenses/calendar?year=2023&month=7&userId={userId}&category={category}

Response:

Status: 200 OK
{
  "1": [
    {
      "amount": 100,
      "userId": "user123",
      "category": "food",
      "date": "2023-07-01T10:30:00.000Z"
    }
  ],
  "4": [
    {
      "amount": 80,
      "userId": "user456",
      "category": "food",
      "date": "2023-07-04T14:20:00.000Z"
    }
  ]
}
  1. 카데고리에 해당하는 소비 항목 및 금액 조회 API(정확한 카데고리)

Request:

GET /expenses/category?q={keyword}&userId={userId}

Response:

Status: 200 OK
[
  {
    "amount": 100,
    "userId": "user123",
    "category": "food",
    "date": "2023-07-04T10:30:00.000Z"
  },
  {
    "amount": 80,
    "userId": "user456",
    "category": "food",
    "date": "2023-07-03T14:20:00.000Z"
  }
]