FXML is intended to create a set of tools for making Forex trading decisions based off of simple calculations of risk and machine/deep learning recommendations. A Flask app made with HTML5, Bootstrap, Python, and Flask with templating by Jinja. App is containerized with Docker for portability. Production environment uses nginx as a reverse proxy to enable SSL
Make sure you have python3 and pip installed.
In the source/ directory, create and activate virtual environment using virtualenv
$ python -m venv python3-virtualenv
$ source python3-virtualenv/bin/activateUse the package manager pip to install all dependencies!
# To install the current requirments listed in requirements.txt
$ pip install -r requirements.txt
# To pip install the latest Flask requirements and save to requirements.txt
$ pip install flask
$ pip freeze > requirements.txtFinally, make sure you have docker and docker-compose installed.
Create a .env file using the example.env template (make a copy using the variables inside of the template)
Start Development Server
$ docker compose -f docker-compose.dev.yml up -dStop Development Server
$ docker compose -f docker-compose.dev.yml downStart Production Server
$ docker compose -f docker-compose.prod.yml up -d --buildStop Production Server
$ docker compose -f docker-compose.prod.yml downFor Development you'll be able to access localhost:5000 or 127.0.0.1:5000 in the browser!
Contributions are welcome. Fork the repo, make your changes, create a diff file, and email the diff file and your GitHub username to luis@moraguez.com. If the changes are approved, you will be added as a contributor to the repo.
If this utility helped you with a project you're working on and you wish to make a donation, you can do so by clicking the donate button that follows. Thank you for your generosity and support!
