From 753809b75dbaaf35a1573e3291fec7970dfa7a08 Mon Sep 17 00:00:00 2001
From: sina <20732540+SinaKhalili@users.noreply.github.com>
Date: Wed, 2 Oct 2024 09:20:23 -0700
Subject: [PATCH] Update Readme, requirements

---
 .env.example     |  1 +
 .gitignore       |  3 ++-
 README.md        | 11 +++++------
 requirements.txt |  2 +-
 4 files changed, 9 insertions(+), 8 deletions(-)
 create mode 100644 .env.example

diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000..d1330df
--- /dev/null
+++ b/.env.example
@@ -0,0 +1 @@
+RPC_URL=""
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index d03fc90..eb98fc4 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,4 +3,5 @@ venv
 **/__pycache__/
 .env
 .venv
-pickles/*
\ No newline at end of file
+pickles/*
+cache
\ No newline at end of file
diff --git a/README.md b/README.md
index 351430f..d190727 100644
--- a/README.md
+++ b/README.md
@@ -2,11 +2,12 @@
 
 
 Quick Start:
-1. Run `export RPC_URL"YOUR_RPC_HERE"` in terminal for static RPC
-2. Create new venv `python3 -m venv venv`
-3. Activate venv `source venv/bin/activate`
+1. Copy .env.example to .env and set RPC_URL
+2. Create new venv `python -m venv .venv`
+3. Activate venv `.venv/bin/activate`
 4. Install dependencies `pip install -r requirements.txt`
-5. `streamlit run src/main.py`
+5. Run the frontend with `streamlit run src/main.py`
+6. Run the backend with `uvicorn src.main:app --host 0.0.0.0 --port 8000`
 
 Current Metrics:
 1. Largest perp positions
@@ -14,5 +15,3 @@ Current Metrics:
 3. Account health distribution
 4. Most levered perp positions > $1m notional
 5. Most levered spot borrows > $750k notional
-
-WIP Metrics:
diff --git a/requirements.txt b/requirements.txt
index 65646f1..db1a771 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -22,7 +22,7 @@ construct==2.10.68
 construct-typing==0.5.3
 Deprecated==1.2.14
 dnspython==2.2.1
-driftpy==0.7.87
+driftpy==0.7.88
 Events==0.5
 exceptiongroup==1.0.4
 flake8==6.0.0