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

EDIT: Solve prettier auto save problem See merge request !25

Merge branch 'feature/README-mockup-img' into 'main'
EDIT: Solve prettier auto save problem See merge request !25
유명현
Commit 54d6a312931e983ed2a0df119222d76b4fd33c58 54d6a312 2 parents 539fecbc cfc7c59b
Showing 1 changed file with 32 additions and 42 deletions
README.md
--- a/README.md
View file @54d6a31
+++ b/README.md
View file @54d6a31
@@ -45,70 +45,62 @@
 ### Prerequisites
 Need to installation docker and docker-compose
-
 - [Docker](https://www.docker.com/get-started/)
 - [Docker-compose](https://docs.docker.com/compose/install/)
 Need to write secret
-
 - `mamuri-bot/database/mysql_init/.env`
-
+   ```dotenv
-  ```dotenv
+   # Database Configuration
-  # Database Configuration
+   TZ=Asia/Seoul
-  TZ=Asia/Seoul
+   MYSQL_HOST={YOUR_MYSQL_HOST}
-  MYSQL_HOST={YOUR_MYSQL_HOST}
+   MYSQL_PORT={YOUR_MYSQL_PORT}
-  MYSQL_PORT={YOUR_MYSQL_PORT}
+   MYSQL_ROOT_PASSWORD={YOUR_MYSQL_ROOT_PASSWORD}
-  MYSQL_ROOT_PASSWORD={YOUR_MYSQL_ROOT_PASSWORD}
+   ```
-  ```
 - `mamuri-bot/joongna/config/.env`
-
+   ```dotenv
-  ```dotenv
+   # Secret Configuration
-  # Secret Configuration
+   SECRET.CLIENTID={NAVER_API_CLIENT_ID}
-  SECRET.CLIENTID={NAVER_API_CLIENT_ID}
+   SECRET.CLIENTSECRET={NAVER_API_CLIENT_SECRET}
-  SECRET.CLIENTSECRET={NAVER_API_CLIENT_SECRET}
+   # Header Configuration
-  # Header Configuration
+   HEADER.COOKIE=NID_SES={YOUR_COOKIE}
-  HEADER.COOKIE=NID_SES={YOUR_COOKIE}
+   HEADER.USERAGENT={YOUR_SYSTEM_USER_AGENT}
-  HEADER.USERAGENT={YOUR_SYSTEM_USER_AGENT}
+   ```
-  ```
 - `mamuri-bot/ngrok/ngrok.yml`
-
+   ```yaml
-  ```yaml
+   authtoken: { YOUR_NGROK_AUTH_TOKEN }
-  authtoken: { YOUR_NGROK_AUTH_TOKEN }
+   version: 2
-  version: 2
+   tunnels:
-  tunnels:
+     mamuri:
-    mamuri:
+       proto: http
-      proto: http
+       addr: mamuri-server:8080
-      addr: mamuri-server:8080
+   ```
-  ```
 - `mamuri-bot/server/config/.env`
-  ```dotenv
+   ```dotenv
-  channelAccessToken: {YOUR_LINE_CHANNEL_ACCESS_TOKEN}
+   channelAccessToken: {YOUR_LINE_CHANNEL_ACCESS_TOKEN}
-  channelId: {YOUR_LINE_CHANNEL_ID}
+   channelId: {YOUR_LINE_CHANNEL_ID}
-  channelSecret: {YOUR_LINE_CHANNEL_SECRET}
+   channelSecret: {YOUR_LINE_CHANNEL_SECRET}
-  ```
+   ```
 ### Installation
 1. Clone the repository
-
 ```shell
 git clone http://khuhub.khu.ac.kr/2018102211/mamuri-bot
 ```
 2. Put your secret files that you create in prerequisite to
-
 ```shell
 mamuri-bot/database/mysql_init/.env
 mamuri-bot/joongna/config/.env
 mamuri-bot/ngrok/ngrok.yml
 mamuri-bot/server/config/.env
-```
+   ```
-
+   
 3. Executing `deploy.sh` for deployment with docker-compose. This script will `build` all images automatically and `docker-compose up` on your system
-
 ```shell
 #!/usr/bin/env bash
 ./deploy.sh
@@ -122,15 +114,13 @@ mamuri-bot/server/config/.env
 ```
 4. Check your ngrok public URL
-
 ```shell
 docker logs mamuri-ngrok
 ```
-
 ![ngrok_deployment_1](http://khuhub.khu.ac.kr/2018102211/mamuri-bot/uploads/4ccdc73c9efc4c3dc58147f17b992cc6/그림1.png)
 5. Set your public URL to Line chatbot configuration for webhook
-   ![ngrok_deployment_2](http://khuhub.khu.ac.kr/2018102211/mamuri-bot/uploads/5dd076f66629948dd1682fc4054ff459/그림2.png)
+![ngrok_deployment_2](http://khuhub.khu.ac.kr/2018102211/mamuri-bot/uploads/5dd076f66629948dd1682fc4054ff459/그림2.png)
 ## Contributing
@@ -149,4 +139,4 @@ MIT 라이센스 아래 사용 가능합니다. LICENSE.txt를 통해 자세한 
 ## Contact
 - 유명현: mhlew0106@khu.ac.kr
-- 윤준석: phobyjun@khu.ac.kr
+- 윤준석: phobyjun@khu.ac.kr
\ No newline at end of file