원티드 1주차 소셜 미디어 통합 Feed 서비스

여러 SNS 서비스의 피드를 통합하여 알림을 받을 수 있는 서비스입니다.

실행 방법

온라인 Swagger UI

swagger.mp4

• deno deploy에 배포된 Swagger UI를 통해 모든 API를 확인하고 실행할 수 있습니다.
• 서버는 main 브랜치의 최신 커밋으로 자동 배포됩니다.
• sqlite의 in-memory 모드를 사용하므로 배포시 모든 데이터가 초기화되나, 이용시 개인정보를 입력하지 말아주세요.

준비 사항

• 서버 실행을 위해 deno 런타임이 필요합니다.
• wasm으로 컴파일 된 sqlite 패키지를 사용하므로 데이터베이스를 설치하실 필요는 없습니다.
• vscode 확장 프로그램을 설치하면 타입 검사 및 다양한 기능을 사용할 수 있습니다.

개발 모드(--watch)로 실행

# 저장소를 클론합니다.
git clone https://github.com/7rd-wanted-pre-onboarding-team-H/w1-social-feed
cd w1-social-feed

# DB에 더미 데이터를 추가합니다. (생략 가능)
deno task db:seed

# 개발 모드로 실행합니다.
deno task dev

http://localhost:8000/ 에서 Swagger UI를 통해 API 문서를 확인하고 실행할 수 있습니다.

프로덕션 모드

deno task prod # 또는 deno run -A main.ts

개발 가이드

• OpenAPI 엔드포인트 정의법
• db 쿼리 빌더 사용법
• 코드 컨벤션 및 테스트 작성법