윤준석 / mamuri-bot

Go to a project
Toggle navigation Toggle navigation pinning
유명현
54d6a312 2 parents 539fecbc cfc7c59b

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

EDIT: Solve prettier auto save problem



See merge request !25
Inline Side-by-side
Showing 1 changed file with 2 additions and 12 deletions
...@@ -45,14 +45,11 @@ ...@@ -45,14 +45,11 @@
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 -
56 ```dotenv 53 ```dotenv
57 # Database Configuration 54 # Database Configuration
58 TZ=Asia/Seoul 55 TZ=Asia/Seoul
...@@ -62,7 +59,6 @@ Need to write secret ...@@ -62,7 +59,6 @@ Need to write secret
62 ``` 59 ```
63 60
64 - `mamuri-bot/joongna/config/.env` 61 - `mamuri-bot/joongna/config/.env`
65 -
66 ```dotenv 62 ```dotenv
67 # Secret Configuration 63 # Secret Configuration
68 SECRET.CLIENTID={NAVER_API_CLIENT_ID} 64 SECRET.CLIENTID={NAVER_API_CLIENT_ID}
...@@ -73,7 +69,6 @@ Need to write secret ...@@ -73,7 +69,6 @@ Need to write secret
73 ``` 69 ```
74 70
75 - `mamuri-bot/ngrok/ngrok.yml` 71 - `mamuri-bot/ngrok/ngrok.yml`
76 -
77 ```yaml 72 ```yaml
78 authtoken: { YOUR_NGROK_AUTH_TOKEN } 73 authtoken: { YOUR_NGROK_AUTH_TOKEN }
79 version: 2 74 version: 2
...@@ -93,22 +88,19 @@ Need to write secret ...@@ -93,22 +88,19 @@ Need to write secret
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
......