diff options
| author | Piyush Dixit <79581397+PiyushDixit96@users.noreply.github.com> | 2021-05-10 22:58:35 +0530 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-10 22:58:35 +0530 |
| commit | 80075290759bbf4c9329d776c70fa5a1ebe59da9 (patch) | |
| tree | 3f5afbb9e5ca97bc61bc18cf05b3485f24a834ab | |
| parent | dcba9fe03123f48a47007674abe6cfa020f55242 (diff) | |
Update README.md
| -rw-r--r-- | README.md | 35 |
1 files changed, 32 insertions, 3 deletions
@@ -1,5 +1,5 @@ <h1 align="center">Welcome to Binance Spot Order Notifier via Telegramđź‘‹</h1> -<h2>Binance does not currently offer notifications when orders are created, cancelled or fulfilled etc.. With this repo you will receive telegram notifications for your binance spot order status.</h2> +<h2>Binance does not currently offer notification when order created, cancelled or fulfilled etc.. With this repo you will receive telegram notification for your binance spot order status.</h2> <p> <img alt="Version" src="https://img.shields.io/badge/version-1.0-blue.svg?cacheSeconds=2592000" /> <a href="https://github.com/PiyushDixit96/binance-order-notifier/blob/main/LICENSE" target="_blank"> @@ -38,12 +38,40 @@ 1. Create account on Heroku (skip if you have) 2. Login to Heroku (if your are not) 3. Click [](https://heroku.com/deploy?template=https://github.com/PiyushDixit96/binance-order-notifier) -4. Follow Steps + + + +5. Give any name in "App name" field +6. Fill required fields in "Config Vars" +7. Click "Depoly app" +8. When you see " Your app was successfully deployed. " your bot started automatically. +9. `important step for preventing idling heroku app`. Click "View" and copy URL when new tab open in your browser + + + +10. Goto [UptimeRobot](https://uptimerobot.com/) and Create free account +11. Click "Add New Monitor" +12. Monitor Type : HTTPS +13. Friendly Name : any name +14. URL (or IP): paste URL of your app. (you copy URL in Step 8) +15. Monitoring Interval : 20 minutes +16. Click " Create Monitor " +17. Now Enjoy ------------ ### Run Locally - Download and install NodeJs - Download Repo and open Repo root folder. -- Fill your data in .env file +- Create .env in root folder and copy , paste below code + ```sh +TELEGRAM_TOKEN="you telegram token" +TELEGRAM_CHAT_ID="your telegram chat id" +BINANCE_API_KEY="binance api key" +BINANCE_SECRET_KEY="binance api sercet" +TIME_ZONE_STRING="your time zone string" + +Time zone string example "Asia/Kolkata" +``` +- Edit required fields in .env file and save - Open terminal on current folder - Run this command to install `npm install` - Run this to start `npm start` @@ -54,6 +82,7 @@ * Twitter: [@PiyushDixit\_](https://twitter.com/PiyushDixit_) * Github: [@PiyushDixit96](https://github.com/PiyushDixit96) +* Telegram: [@Killer_PD](https://t.me/Killer_PD) ## Show your support |