사용하기 전에

git pull을 받으신 후, 로컬에서 클라우드 db를 연결하기 위한 환경변수를 세팅해주어야 합니다. /server 디렉토리에 .env.local 파일을 생성 후, 슬랙 DM으로 보낸 텍스트를 복사 붙여넣기 해주세요...!

사용 방법

1. 설치

yarn: 모노레포 단위의 디펜던시 설치 & 모노레포 구성 재확인
yarn server install: 서버 디펜던시 설치
yarn client install: 클라이언트 디펜던시 설치

세 명령어를 모두 이용하여 설치를 완료해주세요!

2. dev 모드 실행

yarn client dev: 클라이언트 dev 구동
yarn server dev: 서버 dev 구동
또는 yarn dev: 둘 다 구동

프로젝트 루트에서 yarn dev만 해도 client와 server 모두 dev 모드로 구동되니, 이거 하나만 사용하셔도 괜찮습니다! (concurrently 활용)

3. 서버 요청 보내기

기본 테스트

http://localhost:8080/~~~~으로 요청을 보내시면 됩니다. 예시 요청을 localhost:3000/dev 페이지에서 쏘고 있습니다. 해당 페이지에 접속하셔서 콘솔에 Xction Server!가 찍히는 지 확인하세요. (요청 보내는 부분)

useEffect(() => {
    fetch("http://localhost:8080/")
      .then((res) => res.text())
      .then(console.log);
  }, []);

api 문서

api 문서는 /core/dto/~~~service를 확인하세요! (get comment 요청 예시)

/**
 * GET: "comment/:projectId/:timeNodeId"
 * request body is empty
 *
 * @description 특정 프로젝트 - 특정 타임노드에 달린 댓글들을 가져옵니다.
 */
export const GetCommentEndpoint = (projectId: number, timeNodeId: number) => `
  comment/${projectId}/${timeNodeId}
`;
export const GetCommentResponseDto = z.object({
  items: z.array(CommentDto),
});
export type GetCommentResponseDto = z.infer<typeof GetCommentResponseDto>;

이 요청은 주석에 적힌 대로 http:localhost:8080/comment/프로젝트_아이디/타임노드_아이디 로 GET 요청을 보내면 됩니다!

4. 코멘트 관련 api (@lenyakim)

코멘트 api는 현재 가져오는 것과 새로 등록하는 것을 만들어 두었습니다. 수정과 신고는 이후에 작업하겠습니다ㅠ

Get Comment

getComment은 위의 예시에 나와있는 대로 comment/프로젝트_아이디/타임노드_아이디로 요청을 보내면 됩니다.
다만 프로젝트와 타임노드의 id가 아직 정해지지 않았으므로 임의로 0번 프로젝트의 0번 타임노드에 테스트용 코멘트 몇 개를 저장해두었습니다. 따라서 comment/0/0으로 get 요청을 보내시면 응답이 올 겁니다. dev 서버를 구동 후 http:localhost:8080/comment/0/0으로 직접 접속하셔서 응답을 확인하셔도 됩니다.
각 댓글은 type:"COMMENT" | "REPLY" 필드로 댓글인지 대댓글인지를 구분했습니다. 대댓글의 경우 parentCommentId를 추가로 보내므로 달린 댓글의 id와 일치시킬 수 있습니다.

Post New Comment

postComment는 로그인 없이도 작동합니다! 문서에 적힌 대로 post요청을 보내면 랜덤한 유저의 이름으로 코멘트가 등록됩니다. 다만 post는 테스트를 하지 못했으므로 문제가 발생하면 바로 연락주시면 감사하겠습니다.

아직 로그인과 프로젝트 등이 연결되지 않은 상태에서 만든 임시 api이므로 ui에 연결 후 잘 작동하는지 테스트만 부탁드립니다...!

xction-dev / xction.co.kr

Feat/init server #34