서민정 / SEARCH-AND-CHAT

Go to a project
Toggle navigation Toggle navigation pinning
서민정
4155cb38 1 parent d32c26d8

update readme

Inline Side-by-side
Showing 1 changed file with 16 additions and 17 deletions
...@@ -4,12 +4,11 @@ README referred to [Github](https://github.com/othneildrew/Best-README-Template) ...@@ -4,12 +4,11 @@ README referred to [Github](https://github.com/othneildrew/Best-README-Template)
4 <!-- PROJECT LOGO --> 4 <!-- PROJECT LOGO -->
5 <br /> 5 <br />
6 <p align="center"> 6 <p align="center">
7 - <h1 align="center">SEARCH AND CHAT</h1> 7 + <h1>SEARCH AND CHAT</h1>
8 - 8 + <p>
9 -
10 - <p align="center">
11 웹 페이지로 구현된 챗봇과 대화 및 '@'를 이용하여 최신 영상, 정확도 높은 영상, 소식을 카드로 제공합니다. 9 웹 페이지로 구현된 챗봇과 대화 및 '@'를 이용하여 최신 영상, 정확도 높은 영상, 소식을 카드로 제공합니다.
12 - 10 + </p>
11 + <p>
13 <a href="http://khuhub.khu.ac.kr/2017103084/oss-chatbot/">View Demo</a> 12 <a href="http://khuhub.khu.ac.kr/2017103084/oss-chatbot/">View Demo</a>
14 · 13 ·
15 <a href="http://khuhub.khu.ac.kr/2017103084/oss-chatbot/issues">Report Bug</a> 14 <a href="http://khuhub.khu.ac.kr/2017103084/oss-chatbot/issues">Report Bug</a>
...@@ -55,11 +54,11 @@ README referred to [Github](https://github.com/othneildrew/Best-README-Template) ...@@ -55,11 +54,11 @@ README referred to [Github](https://github.com/othneildrew/Best-README-Template)
55 54
56 <!-- GETTING STARTED --> 55 <!-- GETTING STARTED -->
57 ## Getting Started 56 ## Getting Started
58 - 57 +
59 로컬 컴퓨터에서 실행시킬 수 있는 방법입니다. 58 로컬 컴퓨터에서 실행시킬 수 있는 방법입니다.
60 59
61 ### Prerequisites 60 ### Prerequisites
62 - 61 +
63 먼저, 이 프로젝트를 실행시키기 위해 필요한 요구사항입니다. 62 먼저, 이 프로젝트를 실행시키기 위해 필요한 요구사항입니다.
64 63
65 * Node 64 * Node
...@@ -67,21 +66,21 @@ README referred to [Github](https://github.com/othneildrew/Best-README-Template) ...@@ -67,21 +66,21 @@ README referred to [Github](https://github.com/othneildrew/Best-README-Template)
67 또한 `npm` 의 설치도 필요합니다. 66 또한 `npm` 의 설치도 필요합니다.
68 67
69 ### Installation 68 ### Installation
70 - 69 +
71 1. 이 리포지토리를 Clone 합니다. 70 1. 이 리포지토리를 Clone 합니다.
72 ```sh 71 ```sh
73 git clone http://khuhub.khu.ac.kr/2017103084/oss-chatbot/ 72 git clone http://khuhub.khu.ac.kr/2017103084/oss-chatbot/
74 ``` 73 ```
75 - 74 +
76 2. root 폴더와 client 폴더에서 아래 명령을 실행합니다. 75 2. root 폴더와 client 폴더에서 아래 명령을 실행합니다.
77 ```sh 76 ```sh
78 npm install 77 npm install
79 ``` 78 ```
80 - 79 +
81 -3. [Google Developers](https://console.developers.google.com/project)에서 프로젝트를 생성한 뒤, API 키를 발급 받습니다. 이 때, 프로젝트 명(ID)과 API 키의 json 파일이 필요합니다. 80 +3. [Google Developers](https://console.developers.google.com/project)에서 프로젝트를 생성한 뒤, API 키를 발급 받습니다. 이 때, 프로젝트 명(ID)과 API 키의 json 파일이 필요합니다.
82 81
83 82
84 -4. [Dialogflow](https://dialogflow.cloud.google.com/)에서 에이전트를 생성합니다. 이 때, GOOGLE PROJECT 탭의 Project ID는 앞서 (3)에서 생성한 프로젝트의 ID를 선택합니다. 83 +4. [Dialogflow](https://dialogflow.cloud.google.com/)에서 에이전트를 생성합니다. 이 때, GOOGLE PROJECT 탭의 Project ID는 앞서 (3)에서 생성한 프로젝트의 ID를 선택합니다.
85 84
86 85
87 5. root 폴더에 .env 파일을 생성한 뒤, 아래 내용을 채워 넣습니다. 86 5. root 폴더에 .env 파일을 생성한 뒤, 아래 내용을 채워 넣습니다.
...@@ -91,9 +90,9 @@ dialogFlowSessionID = bot-session #원하는 것으로 입력. ...@@ -91,9 +90,9 @@ dialogFlowSessionID = bot-session #원하는 것으로 입력.
91 dialogFlowSessionLanguageCode = Dialogflow 에이전트 생성 시 설정한 언어 코드 (ex. 한글일 경우에는 "ko" 입니다.) 90 dialogFlowSessionLanguageCode = Dialogflow 에이전트 생성 시 설정한 언어 코드 (ex. 한글일 경우에는 "ko" 입니다.)
92 googleClientEmail = 구글 프로젝트 생성 시 제공되는 이메일 (ex. [프로젝트 명]@[프로젝트명 2].iam.gserviceaccount.com) 91 googleClientEmail = 구글 프로젝트 생성 시 제공되는 이메일 (ex. [프로젝트 명]@[프로젝트명 2].iam.gserviceaccount.com)
93 ``` 92 ```
94 - 93 +
95 6. **중요** 로컬에서 실행하는 경우에는 root의 package.json 중 "@google-cloud/storage": "^5.0.1" 를 지웁니다. 이 패키지는 herokuapp에서 GOOGLE_APPLICATION_CREDENTIALS를 활용하기 위해 설치되어있는 패키지입니다. 94 6. **중요** 로컬에서 실행하는 경우에는 root의 package.json 중 "@google-cloud/storage": "^5.0.1" 를 지웁니다. 이 패키지는 herokuapp에서 GOOGLE_APPLICATION_CREDENTIALS를 활용하기 위해 설치되어있는 패키지입니다.
96 - 95 +
97 7. 모두 완료 되었다면, 아래 명령어를 입력하여 클라이언트와 서버를 모두 실행시킬 수 있습니다. 96 7. 모두 완료 되었다면, 아래 명령어를 입력하여 클라이언트와 서버를 모두 실행시킬 수 있습니다.
98 ``` 97 ```
99 npm run dev 98 npm run dev
...@@ -103,8 +102,8 @@ npm run dev ...@@ -103,8 +102,8 @@ npm run dev
103 <!-- USAGE EXAMPLES --> 102 <!-- USAGE EXAMPLES -->
104 ## Usage 103 ## Usage
105 104
106 -해당 프로젝트의 실제 동작 화면은 [SEARCH-AND-CHAT](https://search-and-chat.herokuapp.com/)에서 확인하실 수 있습니다. 105 +해당 프로젝트의 실제 동작 화면은 [SEARCH-AND-CHAT](https://search-and-chat.herokuapp.com/)에서 확인하실 수 있습니다.
107 -React 의 특성 상 뒤로가기 및 Reload 시 오류가 발생할 수 있습니다. 이 때는 아래 URL로 재접속하시면 원활히 사용하실 수 있습니다. 또한 heroku 로 빌드되어 사용이 없는 경우에는 첫 접속 시 로딩 시간이 걸릴 수 있습니다. 조금만 기다려주시면 프로젝트가 실행될 것입니다 😊 106 +React 의 특성 상 뒤로가기 및 Reload 시 오류가 발생할 수 있습니다. 이 때는 아래 URL로 재접속하시면 원활히 사용하실 수 있습니다. 또한 heroku 로 빌드되어 사용이 없는 경우에는 첫 접속 시 로딩 시간이 걸릴 수 있습니다. 조금만 기다려주시면 프로젝트가 실행될 것입니다 😊
108 107
109 108
110 * URL : <https://search-and-chat.herokuapp.com/> 109 * URL : <https://search-and-chat.herokuapp.com/>
...@@ -113,7 +112,7 @@ React 의 특성 상 뒤로가기 및 Reload 시 오류가 발생할 수 있습 ...@@ -113,7 +112,7 @@ React 의 특성 상 뒤로가기 및 Reload 시 오류가 발생할 수 있습
113 <!-- CONTRIBUTING --> 112 <!-- CONTRIBUTING -->
114 ## Contributing 113 ## Contributing
115 114
116 -이 프로젝트를 더욱 발전시키고 싶으신 분들은 아래와 같은 절차를 따라주세요! 115 +이 프로젝트를 더욱 발전시키고 싶으신 분들은 아래와 같은 절차를 따라주세요!
117 116
118 1. Fork the Project 117 1. Fork the Project
119 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) 118 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
......