minitrade

(β˜… 115)

A personal automated trading system

  • .gitignore
  • CHANGELOG.md
  • CONTRIBUTING.md
  • Dockerfile
  • LICENSE.md
  • mkdocs.yml
  • mtctl.sh
  • poetry.lock
  • pyproject.toml
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/dodid/minitrade

Downloads the entire project code from GitHub to your computer.

cd minitrade

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t minitrade .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 minitrade

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
$ pip install minitrade

Installs the Python libraries listed in requirements.txt (or similar).

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation