박찬수 / enjoy_soccer

Go to a project
Toggle navigation Toggle navigation pinning
Ga Min Cha
45e3d509 1 parent 01e31974

Update README.md

Inline Side-by-side
Showing 3 changed files with 28 additions and 10 deletions
1 -# 즐겨찾는 팀을 기반으로 한 축구경기 추천 챗봇 1 +# 축구관련 정보제공 챗봇
2 2
3 <!--Table of Contents--> 3 <!--Table of Contents-->
4 ## Table of Contents 4 ## Table of Contents
...@@ -7,17 +7,23 @@ ...@@ -7,17 +7,23 @@
7 3. Usage 7 3. Usage
8 4. Roadmap 8 4. Roadmap
9 5. Contributing 9 5. Contributing
10 -6. License 10 +6. Contact
11 -7. Contact
12 11
13 <p align="right">(<a href="#top">back to top</a>)</p> 12 <p align="right">(<a href="#top">back to top</a>)</p>
14 13
15 <!--About The Project--> 14 <!--About The Project-->
16 ## About The Project 15 ## About The Project
17 -- 본 프로젝트에서는 사용자가 응원하는 축구팀을 즐겨찾기로 추가하여 챗봇과의 대화를 통해 축구경기에 대한 정보를 얻을 수 있게 서비스를 제공합니다. 16 +- Line 채널 ID로 챗봇을 추가하여 사용할 수 있습니다.
17 +- 해당 챗봇을 통하여 경기 일정과 소속선수 그리고 팀, 득점, 도움 순위 정보를 제공합니다.
18 +- Papago API를 이용하여 한글과 영어 입력이 모두 지원 가능하도록 했습니다.
18 19
19 ### Built With 20 ### Built With
20 - [Node.js](https://nodejs.org/ko/) 21 - [Node.js](https://nodejs.org/ko/)
22 +- [Express](https://expressjs.com/ko/)
23 +- [Javascript](https://developer.mozilla.org/ko/docs/Web/JavaScript)
24 +- [Line API](https://developers.line.biz/en/services/messaging-api/)
25 +- [Papago API](https://developers.naver.com/apps)
26 +- [Sports API](https://www.api-football.com/documentation-v3#section/Authentication)
21 27
22 <p align="right">(<a href="#top">back to top</a>)</p> 28 <p align="right">(<a href="#top">back to top</a>)</p>
23 29
...@@ -33,7 +39,9 @@ npm install ...@@ -33,7 +39,9 @@ npm install
33 ### Installation 39 ### Installation
34 - Messaging API 40 - Messaging API
35 1. Get a free API Key at <https://developers.line.biz/en/services/messaging-api/> 41 1. Get a free API Key at <https://developers.line.biz/en/services/messaging-api/>
36 -2. Clone the repo 42 +- Sports API
43 +2. Get a free API Key at <https://www.api-football.com/>
44 +3. Clone the repo
37 ``` 45 ```
38 git clone http://khuhub.khu.ac.kr/2018102191/enjoy_soccer.git 46 git clone http://khuhub.khu.ac.kr/2018102191/enjoy_soccer.git
39 ``` 47 ```
...@@ -45,10 +53,25 @@ npm install ...@@ -45,10 +53,25 @@ npm install
45 53
46 <!--Usage--> 54 <!--Usage-->
47 ## Usage 55 ## Usage
56 +1. Line 앱에서 "FootballManager" 채널을 추가해 주세요.
57 + - 라인 채널 아이디 : @561ankpu
58 +
59 +2. 채팅창에 들어가면 챗봇이 안내 문구를 전송합니다.
60 +<img src="appscreenshot.jpg" width="300px" height="800px"></img><br/>
61 +
62 +3. 안내 문구에 따라 리그 번호 혹은 팀명을 입력합니다.
63 +<img src="firstmessage.png" width="300px" height="400px"></img><br/>
64 +
48 <p align="right">(<a href="#top">back to top</a>)</p> 65 <p align="right">(<a href="#top">back to top</a>)</p>
49 66
50 <!--Roadmap--> 67 <!--Roadmap-->
51 ## Roadmap 68 ## Roadmap
69 +- [x] Line 채널 만들기
70 +- [x] 한->영, 영->한으로 메세지 번역하기
71 +- [x] leagueID로 teamID 받아오기
72 +- [x] teamID로 leagueID 받아오기
73 +- [x] 메세지 공백 처리하기
74 +- [x] 기능 별 Sports API에서 추출한 json파일 파싱하는 함수 구현하기
52 75
53 <p align="right">(<a href="#top">back to top</a>)</p> 76 <p align="right">(<a href="#top">back to top</a>)</p>
54 77
...@@ -62,11 +85,6 @@ npm install ...@@ -62,11 +85,6 @@ npm install
62 85
63 <p align="right">(<a href="#top">back to top</a>)</p> 86 <p align="right">(<a href="#top">back to top</a>)</p>
64 87
65 -<!--License-->
66 -## License
67 -
68 -<p align="right">(<a href="#top">back to top</a>)</p>
69 -
70 <!--Contact--> 88 <!--Contact-->
71 ## Contact 89 ## Contact
72 - 박찬수 : suplife0@khu.ac.kr 90 - 박찬수 : suplife0@khu.ac.kr
......