새해 결심으로 시작하는 “정원사들” 프로젝트
2021년 새해를 맞이하면서 동아리에서 “정원사들” 프로젝트를 시작했습니다.
정원사들이란 1일1커밋을 하면서 깃헙에 있는 잔디밭을 가꿔가는 것을 목표로 하는 프로젝트입니다.
이 프로젝트는 기존의 정원사들에 참가하셨던 김준호님께서 진행한 프로젝트였고, 이 아이디어를 학교로 가져와서 학우들과 진행하게 되었습니다.
정원사들 프로젝트 진행은 다음과 같습니다.
- 하루에 한 번 커밋하는 것을 목표로 한다. (커밋한 내용이 Slack에 업데이트 된다.)
- 커밋과 함께 배운 내용들을 정리하여 TIL에 작성한다.
커밋하면 위와 같이 슬랙 메시지가 자동으로 생성된다.
정원사들 프로젝트를 도와주는 시스템
이 프로젝트를 진행하면서 멤버들의 의지와 열정을 지켜주기 위해 동기부여하는 커밋 출석부가 있었습니다.
작년에는 김준호님께서 구현해주신 시스템으로 슬랙에 올라오는 커밋 기록들을 수집해서 웹에서 그 기록들을 볼 수 있었습니다.
올해는 직접 구현해보자!
작년과 다르게 올해는 시스템을 직접 구축해보고 싶었습니다. 작년에는 웹으로 동기부여를 했다면 올해는 카카오워크 Bot을 통해 멤버들의 커밋 현황을 하루에 두번 알림을 주어 동기부여를 해보고 싶었습니다. 아래와 같이 프로젝트를 구성했습니다.
프로젝트 구성요소
1. Node.js
2. Express - 기록된 커밋 기록들을 REST API로 제공하는 역할
3. Postgresql - 커밋 기록 저장
4. Docker, Docker-compose - 프로젝트 쉽게 켜고, 끄기
5. Slack API - Node.js에서 Slack 메시지들을 읽는 역할
6. Kakaowork Bot - 커밋한 상태에 따라 사용자들에게 동기부여 연락 보내기
왜 굳이 카카오워크 Bot을 사용했나
- 슬랙 알림이 있지만 슬랙을 불편해하는 멤버가 있었음
- 새롭게 생긴 카카오워크에 대한 개인적인 호기심
카카오워크 알림 봇 개발 가이드
가이드문서: https://docs.kakaoi.ai/kakao_work/botdevguide/process/
카카오워크 Bot을 사용하는 방법은 생각보다 어렵지 않았습니다. 가이드 문서를 읽어가면서 아래 작업들을 했습니다.
가이드 문서를 통해 Bot 개발하는 것은 재밌는 경험이었으나, 카카오워크 자체의 안정성이 떨어진다는 것을 느꼈습니다. 간혹 채팅을 보냈지만 상대방이 늦게 받는다거나 단톡방을 개설해도 제대로 보이지 않는 등의 불편한 점들이 있었습니다.
카카오톡에 익숙한 학우들을 대상으로 하는 것이 아니었다면 Slack으로 알림을 보내지 않았을까,,,
카카오워크 Block Kit Builder
https://www.kakaowork.com/block-kit-builder
카카오워크 블록 킷 빌더로 카카오워크 Bot 문구를 직접 만들고, 바로 코드로 가져다 사용할 수 있습니다. 덕분에 여러 샘플들을 카카오워크에 직접 테스트해보지 않고 바로 경험할 수 있는 것이 큰 장점이었습니다.
Docker 세팅
위 프로젝트 구성요소 중 가장 시간을 많이 할애한 것은 도커였습니다. 작년 정원사들 프로젝트를 진행할 때 김준호님의 백엔드 서버를 사용할 때 Docker 명령어 하나로 바로 실행할 수 있는게 매우 편했었습니다. 이번에 새로 구현하는 것도 그렇게 실행했으면 좋겠어서 퇴사하고 오랜만에 도커 세팅을 해봤습니다.
환경변수를 받아오는 파일을 구성했는데 이것보다 좋은 방법을 찾지 못한게 살짝 아쉬운 부분이었습니다.
-> 노아론 덕분에 해결했습니다. 고마워 친구 👍👍
docker-compose up -d
version: "3"
services:
db:
image: postgres:13
env_file:
- .env
container_name: postgresql
restart: always
ports:
- "${DB_PORT}:${DB_PORT}"
volumes:
- ./schema.sql:/docker-entrypoint-initdb.d/init.sql
- ./docker/data:/var/lib/postgresql/data/
node:
build:
context: .
dockerfile: ./Dockerfile
env_file:
- .env
container_name: express_task
restart: on-failure
working_dir: "/app"
ports:
- "3000:3000"
volumes:
- ./:/app
- /app/node_modules
command: >
bash -c "npm install && mkdir -p log && cron && node app.js"
depends_on:
- db
마무리
구현한 백엔드를 사용해서 사용자들에게 동기부여 푸쉬 알림을 오전 10시, 오후 10시에 두번 보냅니다.
오전 10시에 보내는 메시지는 어제의 출석율을 보여주고 오늘의 커밋을 응원하는 푸쉬 알림을 보내고,
오후 10시에는 남은 2시간 동안 힘내보라는 알림을 보냅니다.
현재까지 95%의 출석율을 유지하고 있습니다. 작년에는 88%의 출석율로 마무리했었는데 이번 알림봇을 통해 작년보다 더 나은 출석율로 마무리했으면 하는 바람입니다. ㅎㅎ
다들 새해 복 많이 받으시고, 구현한 코드에서 에러가 안나길 바래요~