방승일 / find_mbti_bot

Go to a project
Toggle navigation Toggle navigation pinning
Minkyung Ko
0b1b6472 1 parent 5b309152

Update README.md Ver.9

Inline Side-by-side
Showing 1 changed file with 37 additions and 11 deletions
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
6 <img width="300" height="300" src="mbti.jpg"> 6 <img width="300" height="300" src="mbti.jpg">
7 <h1 align="center">Find MBTI chatbot</h1> 7 <h1 align="center">Find MBTI chatbot</h1>
8 8
9 -</div> 9 +</div>
10 10
11 11
12 12
...@@ -18,7 +18,7 @@ ...@@ -18,7 +18,7 @@
18 4. [Usage](#usage) 18 4. [Usage](#usage)
19 5. [Roadmap](#roadmap) 19 5. [Roadmap](#roadmap)
20 6. [Contributing](#contributing) 20 6. [Contributing](#contributing)
21 -7. [Contact](#contact) 21 +7. [Contact](#contact)
22 22
23 23
24 24
...@@ -40,13 +40,15 @@ ...@@ -40,13 +40,15 @@
40 * [Node.js](https://nodejs.org/ko/) 40 * [Node.js](https://nodejs.org/ko/)
41 * [Express](https://expressjs.com/ko/) 41 * [Express](https://expressjs.com/ko/)
42 * [Javascript](https://developer.mozilla.org/ko/docs/Web/JavaScript) 42 * [Javascript](https://developer.mozilla.org/ko/docs/Web/JavaScript)
43 +* [Naver Open API](https://developers.naver.com/main/)
44 +* [Kakao API](https://developers.kakao.com/)
43 45
44 <p align="right">(<a href="#top">back to top</a>)</p> 46 <p align="right">(<a href="#top">back to top</a>)</p>
45 47
46 48
47 49
48 ## Installation 50 ## Installation
49 - 51 +__user__
50 1. Clone the repo 52 1. Clone the repo
51 ``` 53 ```
52 git clone http://khuhub.khu.ac.kr/2018103692/find_mbti_bot 54 git clone http://khuhub.khu.ac.kr/2018103692/find_mbti_bot
...@@ -55,25 +57,48 @@ ...@@ -55,25 +57,48 @@
55 ``` 57 ```
56 npm install 58 npm install
57 ``` 59 ```
58 - 60 +3. Put your secret API KEY in ```.env```
59 -<p align="right">(<a href="#top">back to top</a>)</p> 61 + If you have not installed dotenv module, enter the following command to install.
62 + ```
63 + npm install dotenv
64 + ```
60 65
61 66
67 +__developer__
68 +1. 카카오 채널 생성 및 OBT 신청하기
69 +2. 채널 설정
70 + a) 스킬 생성 : routing이 되는 url 입력
71 + b) 블록 생성하여 스킬과 연결
72 + c) 봇 응답 - 스킬데이터 사용 선택
73 +3. git clone
74 +4. 디렉토리에 있는 app.js에서 각 route마다 다음으로 연결될 블록 ID 입력
75 + 사용자 발화시 UserRequest.blockid나
76 + i.kakao.com의 블록에서 url을 통해 확인할 수 있음
77 +5. 배포
78 +6. npm install
79 +7. 실행
62 80
63 <!-- USAGE EXAMPLES --> 81 <!-- USAGE EXAMPLES -->
64 ## Usage 82 ## Usage
65 83
66 * "MBTI 챗봇" 채널을 추가해 주세요. 84 * "MBTI 챗봇" 채널을 추가해 주세요.
67 link: <http://pf.kakao.com/_jAjtb> 85 link: <http://pf.kakao.com/_jAjtb>
68 -<img src="channel.jpg" width="270px" height="450px"></img><br/> 86 +<img src="channel.jpg" width="270px" height="450px"></img><br/>
69 87
70 -* 또는 아래의 qr코드를 스캔하면 챗봇과 바로 채팅을 시작할 수 있습니다. 88 +* 또는 아래의 qr코드를 스캔하면 챗봇과 바로 채팅을 시작할 수 있습니다.
71 -<img src="qrcode.jpg" width="250px" height="250px"></img><br/> 89 +<img src="qrcode.jpg" width="250px" height="250px"></img><br/>
72 90
73 -* 채팅창에 "안녕"을 입력하면 챗봇이 메시지를 전송합니다. 91 +* 채팅창에 "안녕"을 입력하면 챗봇이 메시지를 전송합니다.
74 -<img src="hello.jpg" width="300px" height="300px"></img><br/> 92 +<img src="hello.jpg" width="300px" height="300px"></img><br/>
75 93
76 * 전송된 메시지에서 "MBTI 테스트 시작하기" 버튼을 터치하면 MBTI 테스트를 진행할 수 있습니다. 94 * 전송된 메시지에서 "MBTI 테스트 시작하기" 버튼을 터치하면 MBTI 테스트를 진행할 수 있습니다.
95 +<img src="test.jpg" width="300px" height="300px"></img><br/>
96 +
97 +* 20개의 질문에 모두 응답을 하면 MBTI 결과가 나타납니다. 본인의 MBTI 관련 게시물들도 확인할 수 있으니 구경해 보세요!
98 +<img src="result.jpg" width="300px" height="300px"></img><br/>
99 +
100 +* 테스트를 하다가 처음부터 다시 시작하고 싶을 때에는 채팅창에 "테스트 시작하기"를 입력해 주세요.
101 +
77 102
78 <p align="right">(<a href="#top">back to top</a>)</p> 103 <p align="right">(<a href="#top">back to top</a>)</p>
79 104
...@@ -85,7 +110,8 @@ ...@@ -85,7 +110,8 @@
85 - [x] Kakao 채널 만들기 110 - [x] Kakao 채널 만들기
86 - [x] express 서버 연결 111 - [x] express 서버 연결
87 - [x] test 112 - [x] test
88 -- [ ] MBTI설문을 챗봇에 적용시키기 113 +- [x] MBTI설문을 챗봇에 적용시키기
114 +- [x] 외부 API 사용하기
89 115
90 116
91 <p align="right">(<a href="#top">back to top</a>)</p> 117 <p align="right">(<a href="#top">back to top</a>)</p>
......