Showing
1 changed file
with
38 additions
and
6 deletions
... | @@ -4,30 +4,62 @@ | ... | @@ -4,30 +4,62 @@ |
4 | 4 | ||
5 | <div align="center"><img src="./images/main_logo.png" width="20%" height="20%"></div> | 5 | <div align="center"><img src="./images/main_logo.png" width="20%" height="20%"></div> |
6 | 6 | ||
7 | -# 주식 알리미 봇(Stock Alert bot) | 7 | +# 주식 뉴스 알리미 봇(Stock news Alert bot) |
8 | +## 최신 뉴스를 쉽고 빠르게 Get 하세요! | ||
8 | 9 | ||
9 | ## About The Project | 10 | ## About The Project |
11 | +- 라인 채팅 어플로 실시간 주식 관련 뉴스를 빠르게 접하기 위해 만들었습니다. | ||
12 | +- 관심 키워드를 입력 시 해당 키워드에 대한 최신 뉴스를 알려줍니다. | ||
13 | +- Naver 검색 API 기반으로 만들어졌습니다. | ||
10 | 14 | ||
11 | ### Project Architecture | 15 | ### Project Architecture |
12 | 16 | ||
13 | ![project_structure](./img/project_structure.png) | 17 | ![project_structure](./img/project_structure.png) |
14 | 18 | ||
15 | ### Built With | 19 | ### Built With |
20 | +* [Node.js](https://nodejs.org/ko/) | ||
21 | +* [Express](https://expressjs.com/ko/) | ||
22 | +* [Javascript](https://developer.mozilla.org/ko/docs/Web/JavaScript) | ||
16 | 23 | ||
17 | -- [Node.js](https://nodejs.org/ko/) | ||
18 | -- [Express](https://expressjs.com/ko/) | ||
19 | - | ||
20 | -## Getting Started | ||
21 | 24 | ||
22 | ### Usage | 25 | ### Usage |
26 | +1. LINE App -> 친구 찾기 -> @858umbav 친구 추가 | ||
27 | +[1](./images/1.png) | ||
28 | +[2](./images/2.png) | ||
29 | + | ||
30 | +2. 채널에 입장하면 다음과 같은 안내문을 받습니다. | ||
31 | +[3](./images/3.png) | ||
32 | + | ||
33 | +3. 'help' 입력 시 사용 방법에 대해 재전송 해드립니다. | ||
34 | +[4](./images/4.png) | ||
35 | + | ||
36 | +4. 'news on' 입력 후 키워드 검색시 해당 관련 뉴스를 보내드립니다. | ||
37 | +[5](./images/5.png) | ||
38 | +[6](./images/6.png) | ||
39 | + | ||
40 | +5. 'news off' 입력 시 뉴스 기능을 종료합니다. | ||
41 | +[7](./images/7.png) | ||
42 | + | ||
43 | +6. 챗봇 푸시 기능으로 '상/하한가 소식'이 있습니다. | ||
44 | +- 1분 마다 '상/하한가' 키워드로 새로운 뉴스를 검색합니다. | ||
45 | +- 새로운 뉴스가 존재할 경우 메신저로 알림을 보냅니다. | ||
46 | +[8](./images/8.png) | ||
47 | + | ||
48 | + | ||
23 | 49 | ||
24 | ### Installation | 50 | ### Installation |
25 | 51 | ||
26 | 1. Clone the repository | 52 | 1. Clone the repository |
27 | -```shell | 53 | +``` |
28 | git clone http://khuhub.khu.ac.kr/2017103049/Stock_Alert_Chatbot.git | 54 | git clone http://khuhub.khu.ac.kr/2017103049/Stock_Alert_Chatbot.git |
29 | ``` | 55 | ``` |
30 | 56 | ||
57 | +2. node.js 서버를 위해서 ```npm install``` 설치를 진행합니다. | ||
58 | + | ||
59 | +3. [Naver Open API](https://developers.naver.com/main/)에서 client id와 secret을 발급 받습니다. | ||
60 | + | ||
61 | +4. [Line messaging API](https://developers.line.biz/en/services/messaging-api/)에서 channel TOKEN을 발급 받습니다. | ||
62 | + | ||
31 | 63 | ||
32 | ## Contributing | 64 | ## Contributing |
33 | 65 | ... | ... |
-
Please register or login to post a comment