프로젝트 개요 - Notipy-DiscordBot/Notipy GitHub Wiki
📌 Notipy 프로젝트 개요
Notipy는 Notion과 Discord를 실시간으로 연결하는 알림 및 자동화 도구입니다.
협업 플랫폼 간 데이터 흐름을 자동화하고, 프로젝트 관리의 일관성과 반응성을 높이는 것을 목표로 개발되었습니다.
🎯 목적
- 협업 플랫폼 간 이벤트 기반 통합 자동화
- 노션에서 발생하는 작업 변화를 디스코드에 실시간 전파
- 개발자 및 팀 사용자들이 빠르게 정보 흐름을 인지하고 대응할 수 있도록 지원
🧱 시스템 구성도
Notion DB ─▶ Webhook Server ─▶ Backend API ─▶ Discord Bot ─▶ Discord 채널
▲ │
└───── DB 연동 및 상태 추적 ┘
- Webhook Server: Notion 이벤트 수신
- Backend API: FastAPI 기반 REST 백엔드
- Database: MySQL 사용 (SQLAlchemy ORM)
- Discord Bot: 슬래시 명령어 기반 사용자 인터페이스 제공
⚙️ 기술 스택
| 구성 요소 | 기술 |
|---|---|
| 백엔드 | Python (FastAPI) |
| 디스코드 봇 | Discord-py-Interactions |
| 데이터베이스 | MySQL + SQLAlchemy |
| 배포 환경 | Docker, Docker Compose |
| 기타 | OAuth2, Webhook, REST, LLM API (선택) |
✨ 핵심 기능 요약
- Notion 페이지 생성/수정 이벤트 → Discord 메시지 전송
- 포럼 채널 내 스레드 자동 생성 및 업데이트
- Discord 명령어를 통한 데이터베이스 연동
- 프로젝트 생성 및 분류 기능
- GitHub 프로필 분석 및 요약 (선택 기능)
- 모든 설정은 서버별로 격리
→ 자세한 내용은 주요 기능 문서를 참고하세요.
📦 배포 옵션
| 방식 | 설명 | 링크 |
|---|---|---|
| 디스코드 초대형 | 디스코드에 봇만 초대하면 즉시 사용 가능 | 초대하여 사용하기 |
| Docker 자가 호스팅 | 서버에 직접 설치 가능 | Docker로 실행하기 |
🔍 활용 예시
- 스터디/동아리: 과제 알림, 출결 관리, 토픽 변경 알림 등
- 소규모 스타트업: 이슈/일정 알림 자동화
- 개인 생산성 도구: 나만의 Notion 페이지 변경 추적
📜 라이선스 및 기여
- Apache 2.0 라이선스 기반
- 누구나 Pull Request를 통해 기여 가능
- [Contributing 가이드](./기여 방법) 참고