Toggle navigation
Toggle navigation
This project
Loading...
Sign in
박시진
/
mamuri-bot
Go to a project
Toggle navigation
Toggle navigation pinning
Projects
Groups
Snippets
Help
Project
Activity
Repository
Pipelines
Graphs
Issues
0
Merge Requests
0
Wiki
Snippets
Network
Create a new issue
Builds
Commits
Issue Boards
Authored by
윤준석
2022-05-28 14:45:02 +0900
Browse Files
Options
Browse Files
Download
Email Patches
Plain Diff
Commit
39046b0e4afa986b6f5cda6ca5b3ac12a63882f5
39046b0e
1 parent
43137d69
DOCS: write README.md
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
85 additions
and
9 deletions
README.md
project_structure.png
README.md
View file @
39046b0
![
node-16.14.2
](
https://img.shields.io/badge/Node-16.14.2-green?style=for-the-badge
)
![
node-17.9.0
](
https://img.shields.io/badge/Node-17.9.0-green
)
![
express-4.18.1
](
https://img.shields.io/badge/Express-4.18.1-green
)
![
sequelize-6.20.0
](
https://img.shields.io/badge/Sequelize-6.20.0-green
)
![
go-1.17.3
](
https://img.shields.io/badge/Go-1.17.3-blue
)
![
goecho-4.7.2
](
https://img.shields.io/badge/Echo-4.7.2-blue
)
![
python-latest
](
https://img.shields.io/badge/Python-latest-blue
)
![
fastapi-0.77.1
](
https://img.shields.io/badge/Fastapi-0.77.1-blue
)
![
mysql-5.7
](
https://img.shields.io/badge/Mysql-5.7-yellowgreen
)
<div
align=
"center"
><img
src=
"./readme_logo.png"
width=
"20%"
height=
"20%"
></div>
#
#
매무리 봇 (Mamuri-bot)
# 매무리 봇 (Mamuri-bot)
사용자에게 입력받은 키워드를 통해 3곳의 중고매물 사이트(중고나라, 당근마켓, 번개장터)에 매물을 감지, 알림을 전송하는 봇입니다.
...
...
@@ -19,27 +28,94 @@
-
[
Node.js
](
https://nodejs.org/ko/
)
-
[
Express
](
https://expressjs.com/ko/
)
-
[
Go
](
https://go.dev/
)
-
[
Echo
](
https://echo.labstack.com
)
-
[
Python
](
https://python.org
)
-
[
FastAPI
](
https://fastapi.tiangolo.com/
)
-
[
ngrok
](
https://ngrok.com
)
## Getting Started
### Prerequisites
-
Node.js
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
MYSQL_HOST={YOUR_MYSQL_HOST}
MYSQL_PORT={YOUR_MYSQL_PORT}
MYSQL_ROOT_PASSWORD={YOUR_MYSQL_ROOT_PASSWORD}
```
-
`mamuri-bot/joongna/config/.env`
```dotenv
# Secret Configuration
SECRET.CLIENTID={NAVER_API_CLIENT_ID}
SECRET.CLIENTSECRET={NAVER_API_CLIENT_SECRET}
# Header Configuration
HEADER.COOKIE=NID_SES={YOUR_COOKIE}
HEADER.USERAGENT={YOUR_SYSTEM_USER_AGENT}
```
-
`mamuri-bot/ngrok/ngrok.yml`
```yaml
authtoken: { YOUR_NGROK_AUTH_TOKEN }
version: 2
tunnels:
mamuri:
proto: http
addr: mamuri-server:8080
```
-
`mamuri-bot/server/config/.env`
```dotenv
channelAccessToken: {YOUR_LINE_CHANNEL_ACCESS_TOKEN}
channelId: {YOUR_LINE_CHANNEL_ID}
channelSecret: {YOUR_LINE_CHANNEL_SECRET}
```
### Installation
1.
Clone the repository
```
git clone http://khuhub.khu.ac.kr/2018102211/secondhand-noti-bot
```
2.
Install NPM packages
git clone http://khuhub.khu.ac.kr/2018102211/mamuri-bot
```
npm install
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.
Start Project
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
# docker build -t daangn-api-server ./daangn/
# docker build -t joongna-api-server ./joongna/
# docker build -t bunjang-api-server ./bunjang/
# docker build -t mamuri-db ./database/
# docker build -t mamuri-server ./server/
# docker build -t mamuri-ngrok ./ngrok/
# docker-compose up -d
```
npm start
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
)
## Contributing
...
...
project_structure.png
View file @
39046b0
353 KB
|
W:
|
H:
380 KB
|
W:
|
H:
2-up
Swipe
Onion skin
Please
register
or
login
to post a comment