This project was developed by the students of Prague City University during the Spring Semester of 2022 as part of the "Secure Application Development" module.
Precondition: You have to be accepted to git secret of this repository.
git clone --recursive https://github.com/Aemilivs/2201-SAD-Bot-Trader.git 2201-SAD-Bot-Trader && cd $_
python3.10 -m venv venv
source venv/bin/activate
pip3 install -r API/requirements.txt
git secret reveal
source API/run.shConsequent runs can be performed by executing flask run and documentation available on 127.0.0.1:5000/docs
git clone --recursive https://github.com/Aemilivs/2201-SAD-Bot-Trader.git 2201-SAD-Bot-Trader && cd $_
python3.10 -m venv venv
source venv/bin/activate
pip3 install -r Flask-UI/requirements.txtConsequent runs can be performed by executing
#For Unix
cd 2201-SAD-Bot-Trader
export FLASK_APP=run.py
# Start the application (development mode)
# --host=0.0.0.0 - expose the app on all network interfaces (default 127.0.0.1)
# --port=5001 - specify the app port (default 5000)
flask run --host=0.0.0.0 --port=5001
# Access the dashboard in browser: http://127.0.0.1:5001/To tun the trading bot API and GUI concurrently and allow their interconnectivity on the same server. Execute the following commands:
cd 2201-SAD-Bot-Trader
#setting the virtual environment
python3.10 -m venv venv
source venv/bin/activate
#Installing the requirements for UI and API
pip3 install -r API/requirements.txt
pip3 install -r Flask-UI/requirements.txt
#Decrypting the encrypted constants
git secret reveal
#In case your public key isn't able to decrypt the constants
#A key can be obtained for free here: https://www.alphavantage.co/
echo "key = 'API_KEY'" > API/trading_api/constants.py
#Running both Flask apps concurrently
sh run.sh
# GUI accessible on: http://127.0.0.1:5001
# API accessible on: http://127.0.0.1:5000Feature list is available here
See the contribution guideline
