Github RestAPI를 통해서 Repository 정보 크롤링 및 알림 서비스 구현

목표

내가 진행하고 있는 프로젝트의 정보를 가져와서 여러 사람들을 지원하고 활용하게 하기 위함이다.

회사에서 개발 함에 있어서 다음과 같은 문제점이 있다.

어쩌다 보니 Repository를 여러개 사용중이다.

• 그에 대한 영향으로 Pull request를 확인해야하는 repository가 많은데 동시에 여러군데서 올라오면 확인하기가 힘들다.
• 주기적으로 확인하는 개발자가 아닌경우에는 리뷰를 잘 확인할 수 있는 방법이 필요하다.
• 또한, 사내 메신저는 이런 알림을 전달하기 위한 제약사항이 있긴하나 만들수는 있을것으로 생각된다.
• 따라서, 위와 같은 기능을 하는 플러그인을 만들기 위한 데이터 크롤링하는 프로그램부터 만들어보자

와 같은 요구사항이 발생했다.

최근 Github Public의 기능 추가를 통해서 내가 리뷰 요청받은 request를 확인할 수 는 있으나, approve가 아닌 comment만 달아도 해당 리스트에서 없어진다. (사내 개발은 결국은 Approved까지가 목표기 때문에 이는 완전히 우리가 필요한 기능은 아니다.)

그래서 개발자들에게 위와 관련 정보를 잘 알려 줄 수 있는 대시보드 혹은 알림 서비스를 구현하기를 원한다.

 

(20231207 추가)
추가적으로 GUI를 통해서 커스텀하게 확인하고 싶은 정보에 필요 정보들을 입력이 가능하도록 설계하면 리액트 같은 것들도 맛보기를 할 수 있을것 같다. 따라서, 프론트 엔드 부분도 추가해보려고 한다.

 

개발 목표

개발 목표는 Github Rest API + Typescript를 활용해서

1. Pull Request, Review 요청 데이터를 DB에 저장 (추가 : DB에 추가할수 있는 admin 프론트 엔드 페이지를 추가한다.)

2. Crontab을 이용한 크롤러 Deploy

3. 이 정보를 띄워주는 Dashboard Deploy

4. 마지막으로 여유가 된다면 이를 카카오톡, discord 혹은 slack 과 같은 메신저에 알림 연동하기.

이를 진행해보려고한다.

 

이를 통해서 Typescript 에 대한 숙련도를 더 높일 수 있을것으로 기대한다.

 

개발 환경

• Podman (Docker)
• Windows

개발 언어

• 백엔드 : Typescript + NodeJS
• DB : PostgreSQL
• 프론트 : React (?)

위를 기반으로 프로젝트를 진행해 볼 예정이다.

참고 링크

GitHub REST API 설명서 - GitHub Docs