Git Product home page Git Product logo

order-alert-bot's Introduction

AboutInstallation

About

The Order Alert Bot listens to FTX orders via websockets using NestJS. For each order you will receive a notification in Telegram.

Installation

⚠️ Best to run the bot on a VPS. I can recommend Hetzner.

  1. Install NodeJS
  2. Clone this repository git clone https://github.com/raftheunis87/order-alert-bot.git
  3. Install all requirements npm install
  4. Rename .env.example to .env and replace the <> placeholders with the correct values:
    • APP_PORT is the port on which you want the application to run
    • TELEGRAM_BOT_TOKEN is the token you receive after creating a bot with the BotFather
    • TELEGRAM_CHAT_ID is the id of the telegram group or channel in which the bot will give the order alerts
    • FTX_ACCOUNTS is an array of objects in which you can add all your FTX subaccounts. Each object needs the following keys:
      • key: the apiKey from FTX (You can/should use a read-only api key)
      • secret: the secret from FTX (You can/should use a read-only api key)
      • subaccount: the name of the subaccount
  5. Run the bot npm run build && npm run start:prod

How can I help?

All kinds of contributions are welcome 🙌! The most basic way to show your support is to ⭐️ star the project, or raise 🐞 issues. You can also buy me some ☕️ coffee to help keep me productive! You can also sent me some crypto to the following addresses:

  • BTC: 3P4eit3YxdokJZNNEF9s6VosG9zAxhj4pS
  • ETH: 0xa3Fe3CDa5cD73022F1935b342dc57FD8C6C34F56
  • USDT (TRC20): THV4oP8LAt7cijNjzccfbFu8KxqdqWS8Ns

Thanks again for your support, it is much appreciated! 🙏

order-alert-bot's People

Contributors

raf-theunis-kbc-be avatar raftheunis87 avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.