From 426de45074e542f2a6890affa09c2170b801afbe Mon Sep 17 00:00:00 2001 From: NiJia Date: Thu, 30 Apr 2020 16:12:00 +0800 Subject: [PATCH] update readme --- README.md | 80 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 47 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index f225596..7cb99aa 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,26 @@ # Flask-LINE-notify +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) +[![Python Version](https://img.shields.io/badge/Python-%3E%3D%203.5-blue.svg)](https://badge.fury.io/py/lotify) -最近看到保哥寫了一篇 [LINE Notify 的文章](https://blog.miniasp.com/post/2020/02/17/Go-Through-LINE-Notify-Without-Any-Code)，詳細的介紹整個操作流程，這個專案則是去實作整個流程的範例。 +前一陣子看到保哥寫了一篇 [LINE Notify 的文章](https://blog.miniasp.com/post/2020/02/17/Go-Through-LINE-Notify-Without-Any-Code)，詳細的介紹整個操作流程，這個專案則是去實作整個流程的範例， + +同時也是 [Lotify](https://github.com/louis70109/lotify) 的範例程式，歡迎大家取用試玩。 # LINE Notify 註冊 可以參考我之前[鐵人賽的文章](https://nijialin.com/2019/09/20/Day5-%E5%81%9A%E4%B8%80%E5%80%8B%E8%88%87-LINE-Notify-%E9%80%A3%E5%8B%95%E7%9A%84%E6%9C%8D%E5%8B%99/)。 -Callback Url 為 `http://localhost:5000/notify/check` +設定的 Callback Url 為 `http://YOUR_DOMAIN/callback`，本地端測試網址就為 `http://localhost:5000/callback` + +# 一鍵部署 + +[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) -# 技能 +按下上面部署按鈕之後需要設定 LINE Notify 所需三個`環境變數` +![heroku-env-settings](https://i.imgur.com/wV5rUyMl.png) -- Python 3.7 -- Flask -- LINE Notify -# 啟動 +# 本地端測試 ```sh cp .env.sample .env @@ -30,48 +36,56 @@ docker-compose up > 兩個方法擇一 -# 使用 +# 步驟 -開啟瀏覽器後輸入 `http://localhost:5000/notify`後就會看到一個輸入按鈕 +### [LINE Notify](https://notify-bot.line.me/zh_TW/) 基本設定 +![](https://i.imgur.com/cqmi2x0l.png) -![](https://i.imgur.com/RraASZL.png) +--- -點選之後會到 LINE 的綁定畫面，選`1對1聊天接收` +### 初始頁面 -![](https://i.imgur.com/jhB3pMV.png) - -這時候 LINE Notify 就會推播一個綁定成功的通知 +開啟瀏覽器後輸入 `http://localhost:5000` 後就會看到一個輸入按鈕 -![](https://i.imgur.com/0KlKrXE.png) +![](https://i.imgur.com/u3W3jOil.png) -同時瀏覽器會被導到`/notify/check` 並帶上 code & state 的資訊 +--- -![](https://i.imgur.com/oGs5NWI.png) +### 綁定通知 - 選擇`1對1聊天接收` +![](https://i.imgur.com/bdGHOqbl.png) -接著再輸入框上輸入文字就會推播囉！ +--- -![](https://i.imgur.com/U9zZnmm.png) +### 連動完成 +這時候 LINE Notify 就會推播一個綁定成功的通知 -結果出爐: +![](https://i.imgur.com/veLmsRkl.png) -![](https://i.imgur.com/KjGXOo3.png) +--- -# 部署 +### 網頁範例 +同時瀏覽器會被導到`/notify/check` 並帶上 code & state 的資訊 +![](https://i.imgur.com/XlkhJwM.png) -[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) +--- -按下上面部署按鈕之後需要設定 LINE Notify 所需三個`環境變數` -![heroku-env-settings](https://i.imgur.com/wV5rUyMl.png) +### 實測內容 +![](https://i.imgur.com/jf1HUqEl.png) +--- # 路由 - GET / - 使用者點選綁定的畫面 -- GET /notify/check - - LINE Notify 認證完後的 callback 路由 -- POST /notify/send - - 幫忙發送推播的路由(因為有[ CORS 問題](https://developer.mozilla.org/zh-TW/docs/Web/HTTP/CORS)所以需要一個 api 來幫忙轉發) - -# License - -The project is available as open source under the terms of the MIT License. +- GET /callback + - LINE Notify 的設定以及認證完後的 callback 路由 +- 幫忙發送推播的路由(因為有[ CORS 問題](https://developer.mozilla.org/zh-TW/docs/Web/HTTP/CORS)所以需要一個 api 來幫忙轉發) + - POST /notify/send + - POST /notify/send_sticker + - POST /notify/send_url + - POST /notify/send_path + - POST /notify/revoke + +# 授權 + +[MIT](https://github.com/louis70109/flask-line-notify/blob/master/MIT-LICENSE)