윤준석 / mamuri-bot

Go to a project
Toggle navigation Toggle navigation pinning
유명현
539fecbc 2 parents 55ae0c96 0f232a12

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

Feature/readme mockup img

목업 이미지 및 이미지 파일을 모아두는 폴더를 생성하였습니다.

See merge request !24
Inline Side-by-side
Showing 4 changed files with 47 additions and 33 deletions
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
10 [![mysql-5.7](https://img.shields.io/badge/Mysql-5.7-yellowgreen?logo=mysql)] (https://www.mysql.com) 10 [![mysql-5.7](https://img.shields.io/badge/Mysql-5.7-yellowgreen?logo=mysql)] (https://www.mysql.com)
11 [![ngrok-v3](https://img.shields.io/badge/ngrok-v3-yellowgreen?logo=ngrok)] (https://ngrok.com) 11 [![ngrok-v3](https://img.shields.io/badge/ngrok-v3-yellowgreen?logo=ngrok)] (https://ngrok.com)
12 12
13 -<div align="center"><img src="./readme_logo.png" width="20%" height="20%"></div> 13 +<div align="center"><img src="./img/readme_logo.png" width="20%" height="20%"></div>
14 14
15 # 매무리 봇 (Mamuri-bot) 15 # 매무리 봇 (Mamuri-bot)
16 16
...@@ -21,9 +21,13 @@ ...@@ -21,9 +21,13 @@
21 - 봇을 사용해 키워드를 입력 받습니다. 21 - 봇을 사용해 키워드를 입력 받습니다.
22 - 주기적 크롤링을 통해 새로운 매물을 감지해 알림을 전송합니다. 22 - 주기적 크롤링을 통해 새로운 매물을 감지해 알림을 전송합니다.
23 23
24 +### Overview
25 +
26 +![mockup_1x](./img/mockup_1x.png)
27 +
24 ### Project Architecture 28 ### Project Architecture
25 29
26 -![project_structure](./project_structure.png) 30 +![project_structure](./img/project_structure.png)
27 31
28 ### Built With 32 ### Built With
29 33
...@@ -41,62 +45,70 @@ ...@@ -41,62 +45,70 @@
41 ### Prerequisites 45 ### Prerequisites
42 46
43 Need to installation docker and docker-compose 47 Need to installation docker and docker-compose
48 +
44 - [Docker](https://www.docker.com/get-started/) 49 - [Docker](https://www.docker.com/get-started/)
45 - [Docker-compose](https://docs.docker.com/compose/install/) 50 - [Docker-compose](https://docs.docker.com/compose/install/)
46 51
47 Need to write secret 52 Need to write secret
53 +
48 - `mamuri-bot/database/mysql_init/.env` 54 - `mamuri-bot/database/mysql_init/.env`
49 - ```dotenv 55 +
50 - # Database Configuration 56 + ```dotenv
51 - TZ=Asia/Seoul 57 + # Database Configuration
52 - MYSQL_HOST={YOUR_MYSQL_HOST} 58 + TZ=Asia/Seoul
53 - MYSQL_PORT={YOUR_MYSQL_PORT} 59 + MYSQL_HOST={YOUR_MYSQL_HOST}
54 - MYSQL_ROOT_PASSWORD={YOUR_MYSQL_ROOT_PASSWORD} 60 + MYSQL_PORT={YOUR_MYSQL_PORT}
55 - ``` 61 + MYSQL_ROOT_PASSWORD={YOUR_MYSQL_ROOT_PASSWORD}
62 + ```
56 63
57 - `mamuri-bot/joongna/config/.env` 64 - `mamuri-bot/joongna/config/.env`
58 - ```dotenv 65 +
59 - # Secret Configuration 66 + ```dotenv
60 - SECRET.CLIENTID={NAVER_API_CLIENT_ID} 67 + # Secret Configuration
61 - SECRET.CLIENTSECRET={NAVER_API_CLIENT_SECRET} 68 + SECRET.CLIENTID={NAVER_API_CLIENT_ID}
62 - # Header Configuration 69 + SECRET.CLIENTSECRET={NAVER_API_CLIENT_SECRET}
63 - HEADER.COOKIE=NID_SES={YOUR_COOKIE} 70 + # Header Configuration
64 - HEADER.USERAGENT={YOUR_SYSTEM_USER_AGENT} 71 + HEADER.COOKIE=NID_SES={YOUR_COOKIE}
65 - ``` 72 + HEADER.USERAGENT={YOUR_SYSTEM_USER_AGENT}
73 + ```
66 74
67 - `mamuri-bot/ngrok/ngrok.yml` 75 - `mamuri-bot/ngrok/ngrok.yml`
68 - ```yaml 76 +
69 - authtoken: { YOUR_NGROK_AUTH_TOKEN } 77 + ```yaml
70 - version: 2 78 + authtoken: { YOUR_NGROK_AUTH_TOKEN }
71 - tunnels: 79 + version: 2
72 - mamuri: 80 + tunnels:
73 - proto: http 81 + mamuri:
74 - addr: mamuri-server:8080 82 + proto: http
75 - ``` 83 + addr: mamuri-server:8080
84 + ```
76 85
77 - `mamuri-bot/server/config/.env` 86 - `mamuri-bot/server/config/.env`
78 - ```dotenv 87 + ```dotenv
79 - channelAccessToken: {YOUR_LINE_CHANNEL_ACCESS_TOKEN} 88 + channelAccessToken: {YOUR_LINE_CHANNEL_ACCESS_TOKEN}
80 - channelId: {YOUR_LINE_CHANNEL_ID} 89 + channelId: {YOUR_LINE_CHANNEL_ID}
81 - channelSecret: {YOUR_LINE_CHANNEL_SECRET} 90 + channelSecret: {YOUR_LINE_CHANNEL_SECRET}
82 - ``` 91 + ```
83 92
84 ### Installation 93 ### Installation
85 94
86 1. Clone the repository 95 1. Clone the repository
96 +
87 ```shell 97 ```shell
88 git clone http://khuhub.khu.ac.kr/2018102211/mamuri-bot 98 git clone http://khuhub.khu.ac.kr/2018102211/mamuri-bot
89 ``` 99 ```
90 100
91 2. Put your secret files that you create in prerequisite to 101 2. Put your secret files that you create in prerequisite to
102 +
92 ```shell 103 ```shell
93 mamuri-bot/database/mysql_init/.env 104 mamuri-bot/database/mysql_init/.env
94 mamuri-bot/joongna/config/.env 105 mamuri-bot/joongna/config/.env
95 mamuri-bot/ngrok/ngrok.yml 106 mamuri-bot/ngrok/ngrok.yml
96 mamuri-bot/server/config/.env 107 mamuri-bot/server/config/.env
97 - ``` 108 +```
98 - 109 +
99 3. Executing `deploy.sh` for deployment with docker-compose. This script will `build` all images automatically and `docker-compose up` on your system 110 3. Executing `deploy.sh` for deployment with docker-compose. This script will `build` all images automatically and `docker-compose up` on your system
111 +
100 ```shell 112 ```shell
101 #!/usr/bin/env bash 113 #!/usr/bin/env bash
102 ./deploy.sh 114 ./deploy.sh
...@@ -110,13 +122,15 @@ mamuri-bot/server/config/.env ...@@ -110,13 +122,15 @@ mamuri-bot/server/config/.env
110 ``` 122 ```
111 123
112 4. Check your ngrok public URL 124 4. Check your ngrok public URL
125 +
113 ```shell 126 ```shell
114 docker logs mamuri-ngrok 127 docker logs mamuri-ngrok
115 ``` 128 ```
129 +
116 ![ngrok_deployment_1](http://khuhub.khu.ac.kr/2018102211/mamuri-bot/uploads/4ccdc73c9efc4c3dc58147f17b992cc6/그림1.png) 130 ![ngrok_deployment_1](http://khuhub.khu.ac.kr/2018102211/mamuri-bot/uploads/4ccdc73c9efc4c3dc58147f17b992cc6/그림1.png)
117 131
118 5. Set your public URL to Line chatbot configuration for webhook 132 5. Set your public URL to Line chatbot configuration for webhook
119 -![ngrok_deployment_2](http://khuhub.khu.ac.kr/2018102211/mamuri-bot/uploads/5dd076f66629948dd1682fc4054ff459/그림2.png) 133 + ![ngrok_deployment_2](http://khuhub.khu.ac.kr/2018102211/mamuri-bot/uploads/5dd076f66629948dd1682fc4054ff459/그림2.png)
120 134
121 ## Contributing 135 ## Contributing
122 136
......