엄민용

Update README.md

Showing 1 changed file with 39 additions and 16 deletions
...@@ -28,7 +28,7 @@ ...@@ -28,7 +28,7 @@
28 <h3 align="center">LineMusicChatbot</h3> 28 <h3 align="center">LineMusicChatbot</h3>
29 29
30 <p align="center"> 30 <p align="center">
31 - 재생 목록을 출력하거나 검색해주는 등 사용자가 입력한 노래 정보를 제공하는 챗봇 31 + 원하는 분야에 대한 음악을 추천해주거나 검색해주는 등 사용자가 원하는 노래 정보를 제공하는 챗봇
32 <br /> 32 <br />
33 <br /> 33 <br />
34 <a href="http://khuhub.khu.ac.kr/2016102927/LineMusicChatbot/raw/master/QR_Code.png">View Demo QR Code</a> 34 <a href="http://khuhub.khu.ac.kr/2016102927/LineMusicChatbot/raw/master/QR_Code.png">View Demo QR Code</a>
...@@ -75,7 +75,7 @@ ...@@ -75,7 +75,7 @@
75 <!-- ABOUT THE PROJECT --> 75 <!-- ABOUT THE PROJECT -->
76 ## About The Project 76 ## About The Project
77 77
78 -![About1](/uploads/cc35689aa8317a34873594d3d9e927a0/About1.PNG) 78 +<img src = "/uploads/fdfa3083b5c1675faeed2d8b6a4025cf/KakaoTalk_20210609_010336213.jpg" width = "400" /> <img src = "/uploads/0edbb62d58ef8fac6cf67b9b1afbd373/KakaoTalk_20210609_010336213_01.jpg" width = "400"/>
79 79
80 음악과 관련한 프로젝트를 선정한 이유는 먼저 우리가 음악을 들을 때 느낄 수 있는 불편한 상황을 생각해 보았고 음악이 듣고는 싶은데 어떤 음악을 들어야할지 망설여지는 상황에서 가수와, 혹은 장르와 관련된 음악을 제공해주는 시스템을 구현하고자 했습니다. 80 음악과 관련한 프로젝트를 선정한 이유는 먼저 우리가 음악을 들을 때 느낄 수 있는 불편한 상황을 생각해 보았고 음악이 듣고는 싶은데 어떤 음악을 들어야할지 망설여지는 상황에서 가수와, 혹은 장르와 관련된 음악을 제공해주는 시스템을 구현하고자 했습니다.
81 81
...@@ -109,7 +109,7 @@ LineMusicChatbot은 라인 챗봇 서비스와 YouTube API를 이용하여 만 ...@@ -109,7 +109,7 @@ LineMusicChatbot은 라인 챗봇 서비스와 YouTube API를 이용하여 만
109 ### Prerequisites 109 ### Prerequisites
110 * Chatbot Application 110 * Chatbot Application
111 * Create info.js 111 * Create info.js
112 -* npm googleapis 112 +* npm
113 ``` 113 ```
114 npm install 114 npm install
115 ``` 115 ```
...@@ -120,10 +120,9 @@ LineMusicChatbot은 라인 챗봇 서비스와 YouTube API를 이용하여 만 ...@@ -120,10 +120,9 @@ LineMusicChatbot은 라인 챗봇 서비스와 YouTube API를 이용하여 만
120 ``` 120 ```
121 git clone http://khuhub.khu.ac.kr/2016102927/LineMusicChatbot.git 121 git clone http://khuhub.khu.ac.kr/2016102927/LineMusicChatbot.git
122 ``` 122 ```
123 -2. Install NPM packages / googleapis 123 +2. Install NPM packages
124 ``` 124 ```
125 npm install 125 npm install
126 - npm install googleapis
127 ``` 126 ```
128 127
129 ### Create Info file 128 ### Create Info file
...@@ -131,8 +130,11 @@ LineMusicChatbot은 라인 챗봇 서비스와 YouTube API를 이용하여 만 ...@@ -131,8 +130,11 @@ LineMusicChatbot은 라인 챗봇 서비스와 YouTube API를 이용하여 만
131 130
132 보안을 위해 토큰 값과 API키를 빼놓았습니다. 131 보안을 위해 토큰 값과 API키를 빼놓았습니다.
133 새 파일 Info.js 을 생성하고 132 새 파일 Info.js 을 생성하고
133 +
134 exports.TOKEN = 'Kb1/rQYz4MUhF8XyKQv7z9x0MxVQ5bX/XO8S/yt/1qQEJVAbsEFAaMvXKEOx9Umr7KhivfyDPfZHRRLFPngR0O4ZGWV2VFses8ufPE7uAdvYr4G6keBNAU69nBz5IC71HfbIrUHxXYqD7GfhVwXzpwdB04t89/1O/w1cDnyilFU=' 134 exports.TOKEN = 'Kb1/rQYz4MUhF8XyKQv7z9x0MxVQ5bX/XO8S/yt/1qQEJVAbsEFAaMvXKEOx9Umr7KhivfyDPfZHRRLFPngR0O4ZGWV2VFses8ufPE7uAdvYr4G6keBNAU69nBz5IC71HfbIrUHxXYqD7GfhVwXzpwdB04t89/1O/w1cDnyilFU='
135 +
135 exports.YoutubeKey = 'AIzaSyBInggOtXxPFYIRee0Xs3vb5iZ9YE9_518' 136 exports.YoutubeKey = 'AIzaSyBInggOtXxPFYIRee0Xs3vb5iZ9YE9_518'
137 +
136 exports.domain='2020105631.oss2021.tk' 138 exports.domain='2020105631.oss2021.tk'
137 을 붙여넣기 해주시기 바랍니다. 139 을 붙여넣기 해주시기 바랍니다.
138 140
...@@ -147,34 +149,55 @@ QR 코드를 이용해 챗봇을 등록해주시기 바랍니다. ...@@ -147,34 +149,55 @@ QR 코드를 이용해 챗봇을 등록해주시기 바랍니다.
147 ## Usage 149 ## Usage
148 150
149 ### PlayList 151 ### PlayList
150 -![Usage_1](/uploads/b7c0c6ca97acebf6c40f204017a1cb69/Usage_1.PNG) <img src = "/uploads/37ea1c6e7854d80e35c8095404efb8e4/Usage_2.PNG" width="700"/> 152 +<img src = "/uploads/ee9c4bfbc32b5d80f45e7b9316eb0a3d/KakaoTalk_20210609_011429047.jpg" width = "400" />
153 +<br />
154 +<img src = "/uploads/ac12d4f8d00e9b3ba2ff3fb7368e47ce/KakaoTalk_20210609_011650392.jpg" width="400"/>
151 155
152 -첫번째 기능은 플레이 리스트를 제공하는 것입니다. 사용자가 입력한 문자열이 플레이리스트에 관한 것일 때, 이것이 저희가 미리 준비해 놓은 플레이리스트라면 그 재생목록 속 노래 10곡의 제목과 URL을 출력하도록 하였습니다. 156 +첫번째 기능은 음악을 추천하는 기능입니다. 사용자가 입력한 문자열이 "플레이리스트"일 때, 챗봇이 선택지를 제공해 음악 추천을 준비합니다.
153 157
158 +원하는 분야를 고르고 또 그 안에서 주어지는 선택지를 선택하면 최종 선택지와 관련한 노래를 무작위로 추천합니다.
154 159
155 이때, 공식 음원을 찾기 힘들다는 단점을 보완하기 위해 URL을 통해 이동하면 공식 음원으로 이동하는 것을 볼 수 있습니다. 160 이때, 공식 음원을 찾기 힘들다는 단점을 보완하기 위해 URL을 통해 이동하면 공식 음원으로 이동하는 것을 볼 수 있습니다.
156 161
157 162
158 지원하는 플레이리스트는 크게 장르, 무드, 가수로 분류하여 제공하는데, 장르의 경우 힙합, 피아노 팝 플레이리스트가 있고, 무드의 경우 슬픈 노래와 신나는 노래에 관한 것이 있으며, 가수의 경우 블랙핑크, 아이유, 트와이스, 레드벨벳의 경우를 지원합니다. 163 지원하는 플레이리스트는 크게 장르, 무드, 가수로 분류하여 제공하는데, 장르의 경우 힙합, 피아노 팝 플레이리스트가 있고, 무드의 경우 슬픈 노래와 신나는 노래에 관한 것이 있으며, 가수의 경우 블랙핑크, 아이유, 트와이스, 레드벨벳의 경우를 지원합니다.
159 164
160 -장르 - 힙합, 피아노, 팝 ex) 힙합 플레이리스트 165 +장르 - 힙합, 피아노, 팝
161 166
162 -무드 - 슬픈, 신나는 ex) 슬픈 플레이리스트 167 +무드 - 슬픈, 신나는
163 168
164 -가수 - 블랙핑크, 아이유, 트와이스 레드벨벳 ex) 블랙핑크 플레이리스트 169 +가수 - 블랙핑크, 아이유, 트와이스 레드벨벳
165 170
166 ### Search in YouTube 171 ### Search in YouTube
167 -![Usage_3](/uploads/e6f48c92d47ac489b2bdac2d6f887aa5/Usage_3.PNG) 172 +<img src = "/uploads/099618e7a1bd707cc0727da840cd134c/KakaoTalk_20210609_011938764.jpg" width = "400" />
168 -두번째 기능은 검색입니다. 사용자가 입력한 정보가 저희가 미처 생각하지 못한 정보라면 해당 문자열을 유튜브에 검색하여 그 검색결과를 출력합니다.
169 173
170 -챗봇은 사용자가 입력한 문자열의 검색결과를 가장 상단에 있는 3개를 출력하고 최상단에 위치한 영상의 썸네일을 출력합니다. 174 +두번째 기능은 검색입니다. 플레이리스트 이외에 자신이 검색하고 싶은 노래가 있다면 유튜브로 번거롭게 이동하여 검색하지 않고 바로 검색할 수 있도록 챗봇 자체에 검색 기능을 추가하였습니다.
171 175
172 -이에 관하여 사용자가 챗봇이 제공하는 정보가 너무 많거나 너무 적은 등 마음에 들지 않을 경우 이에 대해 설정할 수 있는 기능을 추가하였습니다. 176 +챗봇은 사용자가 입력한 문자열의 유튜브 검색 결과중 최상단의 결과를 출력하고, 그 영상의 제목과 URL 그리고 썸네일 정보를 제공합니다.
177 +
178 +이에 관하여 사용자가 판단하기에 챗봇이 썸네일은 보여주지 않았으면 하거나, 출력 정보가 너무 적다고 판단되는 경우를 고려하여 검색에 대하여 설정할 수 있는 기능을 추가하였습니다.
173 179
174 ### Search Setting 180 ### Search Setting
175 -<img src = "/uploads/346dec8dcafa1ed5c0cf568e07dc817e/Usage_4.jpg" width = "300"/> 181 +<img src = "/uploads/5fa9cae43c22178081140ac54e42c8d1/KakaoTalk_20210609_012250106.jpg" width = "400" />
182 +<br />
183 +<img src = "/uploads/a7afaa1278e08adcc2d5717836f84a82/KakaoTalk_20210609_012849616.jpg" width = "400" />
184 +
185 +검색 기능에 대한 커스텀 설정 기능입니다.
186 +
187 +“설정”을 입력하면 자동으로 챗봇이 설정 기능을 차례로 출력하도록 하였습니다.
188 +
189 +설정할 수 있는 기능은 썸네일의 출력 유무, 출력할 동영상의 개수, 영상 URL의 포함 여부입니다.
190 +
191 +각각의 경우 Default값은
192 +
193 +썸네일 출력 – 출력
194 +
195 +출력할 동영상의 개수 – 1개
196 +
197 +URL 포함 여부 – 출력
198 +
199 +입니다.
176 200
177 -검색에 대한 구현 설명은 차후 추가
178 201
179 <!-- ROADMAP --> 202 <!-- ROADMAP -->
180 ## Roadmap 203 ## Roadmap
......