Skip to content

Commit 0f47c01

Browse files
Clarify README local setup instructions
1 parent 14c0deb commit 0f47c01

1 file changed

Lines changed: 40 additions & 5 deletions

File tree

README.md

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -132,15 +132,50 @@ Important areas:
132132

133133
## How to run locally
134134

135-
Run the Python checks from the repository root with `python -m pytest -q`.
135+
The easiest way to view the project is the hosted Vercel demo:
136136

137-
Generate v3 pipeline outputs with `python versions/v3/src/reconciliation/run_v3_pipeline.py`.
137+
https://cash-reconciliation-automation.vercel.app
138138

139-
Generate frontend workbench data with `python versions/v3/src/publish/frontend_workbench_exporter.py`.
139+
To run the full project locally, clone the repository and run the commands below.
140140

141-
Run the frontend with `cd frontend`, then `npm install`, then `npm run dev`.
141+
### 1. Clone the repository
142142

143-
Open `http://localhost:3000`.
143+
git clone https://github.com/xiangtinghe616-blip/cash-reconciliation-automation.git
144+
cd cash-reconciliation-automation
145+
146+
### 2. Set up Python dependencies
147+
148+
python -m venv .venv
149+
source .venv/bin/activate
150+
python -m pip install --upgrade pip
151+
pip install -r requirements-v3.txt
152+
153+
### 3. Run tests and generate v3 outputs
154+
155+
python -m pytest -q
156+
python versions/v3/src/reconciliation/run_v3_pipeline.py
157+
python versions/v3/src/publish/frontend_workbench_exporter.py
158+
159+
### 4. Run the Next.js workbench
160+
161+
cd frontend
162+
npm install
163+
npm run dev
164+
165+
Then open:
166+
167+
http://localhost:3000
168+
169+
### What this local setup runs
170+
171+
This does not install a packaged commercial product.
172+
173+
It runs the repository locally:
174+
175+
- Python generates synthetic reconciliation outputs.
176+
- The frontend exporter creates `frontend/public/demo-data/workbench-data.json`.
177+
- Next.js serves the analyst workbench.
178+
- Staged actions are stored only in the browser through localStorage.
144179

145180
## Version history
146181

0 commit comments

Comments
 (0)