/HRDL-prime

A crypto trading bot, based on Django and Nodejs. For final year project 2022.

Primary LanguageJupyter Notebook


Logo

HRDL

A crypto trading bot that aims to make crypto trading easier and more accessible for the ublic using machine learning techniques
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About HRDL
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About HRDL

The continued development of the Internet to web 3.0 lead to the emergence of new concepts like the spatial web, AI, and cryptocurrencies, which has quickly become a global phenomenon in modern society. The anti-government nature of these currencies combined with the potential of innovation with the technology has allow for several booms market wide. This causes new crypto investors to enter, potentially unprepared for the challenges that they may face. Therefore, with a combination of other web 3.0 technologies (i.e., Artificial Intelligence) a solution can be developed which may produce better results than trading manually. It is essential for this machine learning algorithm to produce the best possible prediction for the crypto trading pair. This project has 2 broad aims:

  • to discover the best timeseries predictive machine learning algorithm for use in a stochastic (having a random probability distribution or pattern that may be analysed statistically but may not be predicted precisely) environment - the crypto trading market.
  • to develop a beginner friendly web application that acts as an interface to a machine learning algorithm.

(back to top)

Built With

Reference

(back to top)

Getting Started

Prerequisites

This aplication requires the installation of docker and docker compose to quickly and effectively get started.

Installation

Below is the step by step methodology of how to install and run the HRDL application

  1. Get a free API Key at https://testnet.binance.vision/

  2. navigate to the deployment/.docker folder

    cd deployment/.docker

  3. Enter your API keys in files

    • tasks.py: 
      api_key = '<your_api_key>'
api_secret = '<your_api_secret>'

t_api_key = '<your_api_key>'
t_api_secret = '<your_api_secret>'
    • test.py: 
      t_api_key = '<your_api_key>'
t_api_secret = '<your_api_secret>'

  4. start up docker containers (-d flag for running in background)

    docker-compose -f docker-compose.yaml up -d

  5. Enter your API key during the login process

  6. put down docker containers

    docker-compose down --volumes

Deployed

HRDL has been deployed to AWS and has a DHCP allocated IP

contact ec19110@qmul.ac.uk for access to this IP

(back to top)

Roadmap

  • Develop Machine learning algorithm
  • Develop Backend
  • Integrate backend with Machine learning model
  • Develop Frontend
  • Integrate backend with frontend
  • Write tests for frontend and backend

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)