유명현

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

Feature/readme mockup img

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

See merge request !24
......@@ -10,7 +10,7 @@
[![mysql-5.7](https://img.shields.io/badge/Mysql-5.7-yellowgreen?logo=mysql)] (https://www.mysql.com)
[![ngrok-v3](https://img.shields.io/badge/ngrok-v3-yellowgreen?logo=ngrok)] (https://ngrok.com)
<div align="center"><img src="./readme_logo.png" width="20%" height="20%"></div>
<div align="center"><img src="./img/readme_logo.png" width="20%" height="20%"></div>
# 매무리 봇 (Mamuri-bot)
......@@ -21,9 +21,13 @@
- 봇을 사용해 키워드를 입력 받습니다.
- 주기적 크롤링을 통해 새로운 매물을 감지해 알림을 전송합니다.
### Overview
![mockup_1x](./img/mockup_1x.png)
### Project Architecture
![project_structure](./project_structure.png)
![project_structure](./img/project_structure.png)
### Built With
......@@ -41,11 +45,14 @@
### 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
# Database Configuration
TZ=Asia/Seoul
......@@ -55,6 +62,7 @@ Need to write secret
```
- `mamuri-bot/joongna/config/.env`
```dotenv
# Secret Configuration
SECRET.CLIENTID={NAVER_API_CLIENT_ID}
......@@ -65,6 +73,7 @@ Need to write secret
```
- `mamuri-bot/ngrok/ngrok.yml`
```yaml
authtoken: { YOUR_NGROK_AUTH_TOKEN }
version: 2
......@@ -84,19 +93,22 @@ Need to write 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
......@@ -110,13 +122,15 @@ 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
......