유명현

Merge branch 'feature/README-mockup-img' into 'main'

EDIT: Solve prettier auto save problem



See merge request !25
Showing 1 changed file with 32 additions and 42 deletions
...@@ -45,70 +45,62 @@ ...@@ -45,70 +45,62 @@
45 ### Prerequisites 45 ### Prerequisites
46 46
47 Need to installation docker and docker-compose 47 Need to installation docker and docker-compose
48 -
49 - [Docker](https://www.docker.com/get-started/) 48 - [Docker](https://www.docker.com/get-started/)
50 - [Docker-compose](https://docs.docker.com/compose/install/) 49 - [Docker-compose](https://docs.docker.com/compose/install/)
51 50
52 Need to write secret 51 Need to write secret
53 -
54 - `mamuri-bot/database/mysql_init/.env` 52 - `mamuri-bot/database/mysql_init/.env`
55 - 53 + ```dotenv
56 - ```dotenv 54 + # Database Configuration
57 - # Database Configuration 55 + TZ=Asia/Seoul
58 - TZ=Asia/Seoul 56 + MYSQL_HOST={YOUR_MYSQL_HOST}
59 - MYSQL_HOST={YOUR_MYSQL_HOST} 57 + MYSQL_PORT={YOUR_MYSQL_PORT}
60 - MYSQL_PORT={YOUR_MYSQL_PORT} 58 + MYSQL_ROOT_PASSWORD={YOUR_MYSQL_ROOT_PASSWORD}
61 - MYSQL_ROOT_PASSWORD={YOUR_MYSQL_ROOT_PASSWORD} 59 + ```
62 - ```
63 60
64 - `mamuri-bot/joongna/config/.env` 61 - `mamuri-bot/joongna/config/.env`
65 - 62 + ```dotenv
66 - ```dotenv 63 + # Secret Configuration
67 - # Secret Configuration 64 + SECRET.CLIENTID={NAVER_API_CLIENT_ID}
68 - SECRET.CLIENTID={NAVER_API_CLIENT_ID} 65 + SECRET.CLIENTSECRET={NAVER_API_CLIENT_SECRET}
69 - SECRET.CLIENTSECRET={NAVER_API_CLIENT_SECRET} 66 + # Header Configuration
70 - # Header Configuration 67 + HEADER.COOKIE=NID_SES={YOUR_COOKIE}
71 - HEADER.COOKIE=NID_SES={YOUR_COOKIE} 68 + HEADER.USERAGENT={YOUR_SYSTEM_USER_AGENT}
72 - HEADER.USERAGENT={YOUR_SYSTEM_USER_AGENT} 69 + ```
73 - ```
74 70
75 - `mamuri-bot/ngrok/ngrok.yml` 71 - `mamuri-bot/ngrok/ngrok.yml`
76 - 72 + ```yaml
77 - ```yaml 73 + authtoken: { YOUR_NGROK_AUTH_TOKEN }
78 - authtoken: { YOUR_NGROK_AUTH_TOKEN } 74 + version: 2
79 - version: 2 75 + tunnels:
80 - tunnels: 76 + mamuri:
81 - mamuri: 77 + proto: http
82 - proto: http 78 + addr: mamuri-server:8080
83 - addr: mamuri-server:8080 79 + ```
84 - ```
85 80
86 - `mamuri-bot/server/config/.env` 81 - `mamuri-bot/server/config/.env`
87 - ```dotenv 82 + ```dotenv
88 - channelAccessToken: {YOUR_LINE_CHANNEL_ACCESS_TOKEN} 83 + channelAccessToken: {YOUR_LINE_CHANNEL_ACCESS_TOKEN}
89 - channelId: {YOUR_LINE_CHANNEL_ID} 84 + channelId: {YOUR_LINE_CHANNEL_ID}
90 - channelSecret: {YOUR_LINE_CHANNEL_SECRET} 85 + channelSecret: {YOUR_LINE_CHANNEL_SECRET}
91 - ``` 86 + ```
92 87
93 ### Installation 88 ### Installation
94 89
95 1. Clone the repository 90 1. Clone the repository
96 -
97 ```shell 91 ```shell
98 git clone http://khuhub.khu.ac.kr/2018102211/mamuri-bot 92 git clone http://khuhub.khu.ac.kr/2018102211/mamuri-bot
99 ``` 93 ```
100 94
101 2. Put your secret files that you create in prerequisite to 95 2. Put your secret files that you create in prerequisite to
102 -
103 ```shell 96 ```shell
104 mamuri-bot/database/mysql_init/.env 97 mamuri-bot/database/mysql_init/.env
105 mamuri-bot/joongna/config/.env 98 mamuri-bot/joongna/config/.env
106 mamuri-bot/ngrok/ngrok.yml 99 mamuri-bot/ngrok/ngrok.yml
107 mamuri-bot/server/config/.env 100 mamuri-bot/server/config/.env
108 -``` 101 + ```
109 - 102 +
110 3. Executing `deploy.sh` for deployment with docker-compose. This script will `build` all images automatically and `docker-compose up` on your system 103 3. Executing `deploy.sh` for deployment with docker-compose. This script will `build` all images automatically and `docker-compose up` on your system
111 -
112 ```shell 104 ```shell
113 #!/usr/bin/env bash 105 #!/usr/bin/env bash
114 ./deploy.sh 106 ./deploy.sh
...@@ -122,15 +114,13 @@ mamuri-bot/server/config/.env ...@@ -122,15 +114,13 @@ mamuri-bot/server/config/.env
122 ``` 114 ```
123 115
124 4. Check your ngrok public URL 116 4. Check your ngrok public URL
125 -
126 ```shell 117 ```shell
127 docker logs mamuri-ngrok 118 docker logs mamuri-ngrok
128 ``` 119 ```
129 -
130 ![ngrok_deployment_1](http://khuhub.khu.ac.kr/2018102211/mamuri-bot/uploads/4ccdc73c9efc4c3dc58147f17b992cc6/그림1.png) 120 ![ngrok_deployment_1](http://khuhub.khu.ac.kr/2018102211/mamuri-bot/uploads/4ccdc73c9efc4c3dc58147f17b992cc6/그림1.png)
131 121
132 5. Set your public URL to Line chatbot configuration for webhook 122 5. Set your public URL to Line chatbot configuration for webhook
133 - ![ngrok_deployment_2](http://khuhub.khu.ac.kr/2018102211/mamuri-bot/uploads/5dd076f66629948dd1682fc4054ff459/그림2.png) 123 +![ngrok_deployment_2](http://khuhub.khu.ac.kr/2018102211/mamuri-bot/uploads/5dd076f66629948dd1682fc4054ff459/그림2.png)
134 124
135 ## Contributing 125 ## Contributing
136 126
...@@ -149,4 +139,4 @@ MIT 라이센스 아래 사용 가능합니다. LICENSE.txt를 통해 자세한 ...@@ -149,4 +139,4 @@ MIT 라이센스 아래 사용 가능합니다. LICENSE.txt를 통해 자세한
149 ## Contact 139 ## Contact
150 140
151 - 유명현: mhlew0106@khu.ac.kr 141 - 유명현: mhlew0106@khu.ac.kr
152 -- 윤준석: phobyjun@khu.ac.kr 142 +- 윤준석: phobyjun@khu.ac.kr
...\ No newline at end of file ...\ No newline at end of file
......