Showing
1 changed file
with
22 additions
and
16 deletions
... | @@ -14,7 +14,7 @@ | ... | @@ -14,7 +14,7 @@ |
14 | 14 | ||
15 | 1. [About The Project](#about-the-project) | 15 | 1. [About The Project](#about-the-project) |
16 | 2. [Built With](#built-with) | 16 | 2. [Built With](#built-with) |
17 | -3. [Installation](#installation) | 17 | +3. [Getting Started](#getting-started) |
18 | 4. [Usage](#usage) | 18 | 4. [Usage](#usage) |
19 | 5. [Roadmap](#roadmap) | 19 | 5. [Roadmap](#roadmap) |
20 | 6. [Contributing](#contributing) | 20 | 6. [Contributing](#contributing) |
... | @@ -47,8 +47,9 @@ | ... | @@ -47,8 +47,9 @@ |
47 | 47 | ||
48 | 48 | ||
49 | 49 | ||
50 | -## Installation | 50 | +## Getting Started |
51 | __user__ | 51 | __user__ |
52 | +0. Install Node.js(https://nodejs.org/ko/) | ||
52 | 1. Clone the repo | 53 | 1. Clone the repo |
53 | ``` | 54 | ``` |
54 | git clone http://khuhub.khu.ac.kr/2018103692/find_mbti_bot | 55 | git clone http://khuhub.khu.ac.kr/2018103692/find_mbti_bot |
... | @@ -58,8 +59,12 @@ __user__ | ... | @@ -58,8 +59,12 @@ __user__ |
58 | npm install | 59 | npm install |
59 | ``` | 60 | ``` |
60 | 3. Put your secret API KEY in `.env` | 61 | 3. Put your secret API KEY in `.env` |
61 | - If you have not installed dotenv module, enter the following command to install. | 62 | + This project needs Naver Open API(Client ID, Client Secret) & Kakao API(Kakao REST API Key) |
63 | + | ||
64 | +4. If modules are not installed, enter the following command to install: | ||
62 | ``` | 65 | ``` |
66 | + npm install express --save | ||
67 | + npm install router | ||
63 | npm install dotenv | 68 | npm install dotenv |
64 | ``` | 69 | ``` |
65 | 70 | ||
... | @@ -74,32 +79,33 @@ __developer__ | ... | @@ -74,32 +79,33 @@ __developer__ |
74 | 4. 디렉토리에 있는 app.js에서 각 route마다 다음으로 연결될 블록 ID 입력 | 79 | 4. 디렉토리에 있는 app.js에서 각 route마다 다음으로 연결될 블록 ID 입력 |
75 | 사용자 발화시 UserRequest.blockid나 | 80 | 사용자 발화시 UserRequest.blockid나 |
76 | i.kakao.com의 블록에서 url을 통해 확인할 수 있음 | 81 | i.kakao.com의 블록에서 url을 통해 확인할 수 있음 |
77 | -5. 배포 | 82 | +5. 배포 및 실행 |
78 | -6. npm install | 83 | + |
79 | -7. 실행 | 84 | + |
85 | +<p align="right">(<a href="#top">back to top</a>)</p> | ||
80 | 86 | ||
81 | 87 | ||
82 | 88 | ||
83 | <!-- USAGE EXAMPLES --> | 89 | <!-- USAGE EXAMPLES --> |
84 | ## Usage | 90 | ## Usage |
85 | 91 | ||
86 | -* "MBTI 챗봇" 채널을 추가해 주세요. | 92 | +* "MBTI 챗봇" 채널을 추가해 주세요. |
87 | link: <http://pf.kakao.com/_jAjtb> | 93 | link: <http://pf.kakao.com/_jAjtb> |
88 | -<img src="channel.jpg" width="270px" height="450px"></img><br/> | 94 | +<img src="channel.jpg" width="270px" height="450px"></img><br/> |
89 | 95 | ||
90 | -* 또는 아래의 qr코드를 스캔하면 챗봇과 바로 채팅을 시작할 수 있습니다. | 96 | +* 또는 아래의 qr코드를 스캔하면 챗봇과 바로 채팅을 시작할 수 있습니다. |
91 | -<img src="qrcode.jpg" width="250px" height="250px"></img><br/> | 97 | +<img src="qrcode.jpg" width="250px" height="250px"></img><br/> |
92 | 98 | ||
93 | -* 채팅창에 "안녕"을 입력하면 챗봇이 메시지를 전송합니다. | 99 | +* 채팅창에 "안녕"을 입력하면 챗봇이 메시지를 전송합니다. |
94 | -<img src="hello.jpg" width="300px" height="300px"></img><br/> | 100 | +<img src="hello.jpg" width="300px" height="300px"></img><br/> |
95 | 101 | ||
96 | -* 전송된 메시지에서 "MBTI 테스트 시작하기" 버튼을 터치하면 MBTI 테스트를 진행할 수 있습니다. | 102 | +* 전송된 메시지에서 "MBTI 테스트 시작하기" 버튼을 터치하면 MBTI 테스트를 진행할 수 있습니다. |
97 | <img src="test.jpg" width="300px" height="400px"></img><br/> | 103 | <img src="test.jpg" width="300px" height="400px"></img><br/> |
98 | 104 | ||
99 | -* 20개의 질문에 모두 응답을 하면 MBTI 결과가 나타납니다. 본인의 MBTI 관련 게시물들도 확인할 수 있으니 구경해 보세요! | 105 | +* 20개의 질문에 모두 응답을 하면 MBTI 결과가 나타납니다. 본인의 MBTI 관련 게시물들도 확인할 수 있으니 구경해 보세요! |
100 | -<img src="result.jpg" width="300px" height="300px"></img><br/> | 106 | +<img src="result.jpg" width="300px" height="350px"></img><br/> |
101 | 107 | ||
102 | -* 테스트를 하다가 처음부터 다시 시작하고 싶을 때에는 채팅창에 "테스트 시작하기"를 입력해 주세요. | 108 | +* 테스트를 하다가 처음부터 다시 시작하고 싶을 때에는 채팅창에 "테스트 시작하기"를 입력해 주세요. |
103 | 109 | ||
104 | 110 | ||
105 | <p align="right">(<a href="#top">back to top</a>)</p> | 111 | <p align="right">(<a href="#top">back to top</a>)</p> | ... | ... |
-
Please register or login to post a comment