Prography 6th NodeJS Quest

프로그파피 NodeJS 전형의 비중은 면접(70%), 과제(30%) 입니다. 과제의 완성도보다 면접이 더 중요합니다.

1.개요

프로그라피는 짧은 기간동안 멋진 서비스를 뚝딱 만들어내기 때문에 서버 개발 능력이 굉장히 중요합니다. 프로그라피 활동에 필요한 기초적인 서버 개발 능력 확인하기 위해 사전과제를 진행하고 있습니다. 사전과제에서는 간단한 기획과 함께 요청-응답 예시가 주어지고, 주어진 요구사항에 맞춰 서버를 구현할 수 있는 지를 확인합니다.

과제의 진행은 이 레포지토리를 fork 한 뒤에 지원자의 깃헙에 올리는 방식 으로 진행합니다. fork하는 방법을 잘 모르신다면, 여기를 눌러 진행 해주시기 바랍니다. fork 후에도 지원자의 깃헙에서 과제를 확인할 수 있습니다.

더 궁금한 것이 있으시면 NodeJS 운영진 오픈채팅방 으로 오세요! ~~(날씨 물어보셔도 되요)~~

2.개발환경

Node 10 이상
ES6 이상 문법 사용(babel-node)
nodemon(코드 수정시 자동 재시작)
express
body-parser
dotenv

개발에만 집중할 수 있도록, 일부 서버 환경(express)이 포함되어 있습니다. src 디렉토리에서 작업을 하시면 됩니다. 이 레포지토리를 클론한 후에 다음의 명령어로 서버를 시작할 수 있습니다.

# packages 설치
> npm install

# 서버 실행
> npm start

3.과제

다음의 기획과 API목록을 읽고, 적절한 Restful API 서버 를 구현해주시기 바랍니다. 서버 개발시 데이터베이스를 꼭 사용해야합니다. 데이터베이스의 선택과 ORM 사용은 자유입니다. API목록에 정의된 목록에 요청을 보냈을 때, 정상 작동하는 API의 갯수로 개발이 정상적으로 수행 되었음을 확인합니다. 채점 방법은 5.채점방법을 확인해주세요.

a.기획

철수는 할일을 만들고 관리할 수 있는 프로그램을 제작하고자한다. 이 프로그램에는 다음과 같은 기능이 있다.

할일이 있다.
할일은 데이터베이스에 저장이 된다.

할일은 다음의 필드를 가지고 있다.

Todo {
  id: number; // 숫자, 자동 생성
  title: string; // 문자열, 필수값
  description: string; // 문자열, 필수 값,
  tags: string[]; // 배열, 옵션 ex) ["prography", "nodejs"]
  isCompleted: boolean; // 참불, 초깃값: false
  createdAt: Date; // 날짜, 생성시 자동 생성
  updatedAt: Date; // 날짜, 생성시 자동 생성, 수정시 자동 갱신,
}

할일을 등록/수정/삭제 할 수 있다.
할일을 완료 표시를 할 수 있다.
할일에 태그를 삽입할 수 있다.
(옵션)할일을 태그로 모아서 볼 수 있다.
(옵션)할일을 생성된 순서로 정렬할 수 있다.
(옵션)할일을 제목 또는 설명의 내용의 일부분으로 검색할 수 있다.
할일에 댓글을 등록/수정/삭제 할 수 있다.

댓글은 다음의 필드를 가지고 있다.

  Comment {
    id: number; // 숫자, 자동 생성
    contents: string; // 문자열, 필수값
    createdAt: Date; // 날짜, 생성시 자동 생성
    updatedAt: Date; // 날짜, 생성시 자동 생성, 수정시 자동 갱신,
  }

b.API목록

이 서버에서 요구하는 API는 총 11개입니다.

할일 등록: POST /todos
할일 목록: GET /todos
할일 읽기: GET /todos/:todoId
할일 수정: PUT /todos/:todoId
할일 완료: PUT /todos/:todoId/complete
할일 삭제: DELETE /todos/:todoId
할일에 댓글 등록: POST /todos/:todoId/comments
할일의 댓글 목록: GET /todos/:todoId/comments
할일의 댓글 읽기: GET /todos/:todoId/comments/:commentId
할일의 댓글 수정: PUT /todos/:todoId/comments/:commentId
할일의 댓글 삭제: DELETE /todos/:todoId/comments/:commentId

각 API의 요청, 응답 예시를 확인해주세요.

4.제출방법

fork가 된 이후에 진행하기 때문에, 제출이 필요 없습니다. 마감일 기준 23:59:59 까지의 커밋까지 인정이됩니다.

5.채점방법

npm test 명령어를 실행하면, 각 API들에 대하여 e2e 테스트를 미리 진행할 수 있습니다. 목록에 있는 모든 API(11개)중 생성 관련 코드는 3번, 이외의 요청은 각 한번씩 호출합니다. 테스트를 통과한 항목 수로 점수를 채점합니다. 테스트 코드는 test 폴더에 정의되어있습니다. 테스트 라이브러리는 jest와 supertest를 사용합니다.

가산점 항목

가산점 항목의 세부 개발(정렬, 필터 기능)이 포함되는 경우 추가 점수를 받을 수 있습니다. 과제와 면접을 모두 마친 후에 점수가 완전 동일한 지원자가 있는 경우에만 가산점이 적용됩니다.

브랜치를 나누어서 개발
validation 처리, 빈값의 경우 클라이언트 측 에러임을 알려주기
아래의 기능을 추가로 개발합니다.
1. 할일 정렬: GET /todos?order[createdAt]=desc
2. 할일 검색1: GET /todos?title=%과제%
3. 할일 검색2: GET /todos?description=%프로그라피%
4. 할일 검색3: GET /todos?tags[]=prography&tags[]=nodejs

Tip: 위의 URL쿼리(?order[createdAt]=desc)의 경우 qs 라이브러리를 사용하시면 쉽게 구현이 가능합니다.

wwlee94 / prography-6th-nodejs-quest