README_ko.md

Chat Bot

3학년 2학기 - 오픈소스프로그래밍

JBNU (Winter 2022) - Team(10) Project

---

📖 목차

내용

1. ➤ 프로젝트 개요
2. ➤ 기능
3. ➤ 소스파일 설명
4. ➤ API
5. ➤ 사전 환경 설정
6. ➤ 실행하기
7. ➤ 프로젝트에 기여하기
8. ➤ 참고 문서

🖼️ 프로젝트 개요

슬랙기반으로 실행되는 챗봇 프레임워크입니다. 전북대학교에 대한 다양한 정보를 물어 볼 수 있어요!

슬랙으로 팀과 작업을 하면서 학교에 대한 정보를 알고싶으시다면 이 오픈소스를 활용 해보세요

📟 기능

• 질문 & 응답 - 학사 일정 - 학교 급식 메뉴 ⭐(최대 3개) - 각 학과 사무실 정보
• 추가 될 사항

📒 소스파일 설명

• /src/bot
  • 봇 클래스로 기본 Base 봇 클래스, Main Slack 봇 클래스, Test 전용 봇 클래스가 있습니다.
• greeting.js
  • 봇에게 hi하고 인사를 했을 때 응답을 주는 스크립트입니다.
• main.js
  • 여기에서 봇의 토큰을 가져와 봇을 실행하고 테스트 봇도 실행합니다.

🎛️ API

**Slack Real Time Messaging**

🪛 사전 환경 설정

• node -version : [up 16.x]
• slack workspace & app
  • 먼저 슬랙 워크 스페이스를 만들어주세요. 그리고 나서 app을 추가해주세요. (rtm-api를 사용하려면 app은 class 버전이어야합니다.) class 버전 앱 만들기 참고

⛳ 실행하기

• 프로젝트 클론

  git clone https://github.com/10TeamPro/botProject.git

• npm 설치

  npm install

• 새 폴더를 만든 후 그 안에 ./config/bot.json 파일을 만드세요

  bot.json 파일에서 작성해야할 것 app에 접속 후 봇 유저 토큰을 복사합니다. 토큰은 ‘xoxb-*’ 와 같은 형태입니다. 다음과 같이 개인 토큰을 추가할 수 있습니다.

  "MAIN_TOKEN": "xoxb-YOURTOKEN",

• 봇 작동시키기

  node src/main.js

🎊 프로젝트에 기여하기

만약 저희의 코드에 버그가 있거나 개선사항이 필요하다고 생각하시면 PR을 주세요! PR을 주실 때는 저희가 올려놓은 eslint와 prettier의 양식에 따라서 코드를 작성해 주세요! ( 관련된 문서는 노션에서도 확인할 수 있습니다 Notion )

이 오픈소스에 대한 모든 참여/ 참견은 환영합니다.

• PR 주세요!
• 이슈도 주세요!

💾 참고 문서

• Notion