diff --git a/README.md b/README.md index 00fab23..76e0893 100644 --- a/README.md +++ b/README.md @@ -133,17 +133,35 @@ crypto-trading-backtesting/ ```sh pip install -r requirements.txt ``` -4. **Run React interface** +4. **Configure environmnet variables and configurations:** + ``` + .env + app/config.py + ``` +5. **Run backend api and mlflow server:** + ```sh + mlflow server --host 127.0.0.1 --port 5050 + python run.py + ``` +6. **Run frontend interface** ```sh - streamlit run src/frontend/app.py + cd frontend/ + npm install + npm run start ``` -5. **Run Chronos** +7. **Run Chronos** ```sh pip install git+https://github.com/amazon-science/chronos-forecasting.git pip install pandas numpy torch sqlalchemy psycopg2-binary matplotlib chronos ``` +#### Altenative +1. **Run run_project.sh file:** + ``` + sh run_prject.sh + ``` + ## Usage 1. **Provide input descriptions** of the trading strategies, including scenarios and expected outputs. diff --git a/run_project.sh b/run_project.sh index e3d13ac..28dbb43 100644 --- a/run_project.sh +++ b/run_project.sh @@ -1,3 +1,3 @@ mlflow server --host 127.0.0.1 --port 5050 - python3 run.py - \ No newline at end of file + python run.py + cd frontend && npm install && npm run start \ No newline at end of file diff --git a/screenshots/backtest_results.png b/screenshots/backtest_results.png new file mode 100644 index 0000000..7ce97a4 Binary files /dev/null and b/screenshots/backtest_results.png differ