Skip to content

Commit 2e8a8e1

Browse files
authored
Revise README with setup instructions and formatting
Updated formatting and added setup instructions for chatbot and compliance checklist.
1 parent 221fb94 commit 2e8a8e1

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -173,16 +173,16 @@ cd frontend
173173
npm install
174174
npm run dev
175175
Chatbot Setup
176-
bash
177-
Copy code
176+
```
177+
```bash
178178
cd "Python RAG chatbot"
179179
python -m venv .venv
180180
.\.venv\Scripts\Activate.ps1
181181
pip install -r requirements.txt
182182
uvicorn src.api_server:app --reload --host 0.0.0.0 --port 8000
183183
Compliance Checklist Setup
184-
bash
185-
Copy code
184+
```
185+
```bash
186186
cd Compliance_checklist
187187
python -m venv .venv
188188
.\.venv\Scripts\Activate.ps1
@@ -193,29 +193,26 @@ uvicorn src.api_server:app --reload --host 0.0.0.0 --port 8001
193193
Windows
194194

195195
```bash
196-
Copy code
197196
run-tests.bat
198197
run-tests.bat --coverage
199198
run-tests.bat --controller
200199
Mac/Linux
201200
```
202201

203202
```bash
204-
Copy code
205203
./run-tests.sh
206204
./run-tests.sh --coverage
207205
./run-tests.sh --controller
208206
Manual
209207
```
210208

211209
```bash
212-
Copy code
213210
mvn clean test
214211
mvn test -Dtest=TariffManagementControllerIntegrationTest
215212
mvn jacoco:report
216213
```
217214

218-
##🌐 Deployed Servers
215+
## 🌐 Deployed Servers
219216
Service URL
220217
Frontend https://trade-optimisation-pathfinder.vercel.app
221218
Backend https://cs203tariffproject.duckdns.org
@@ -224,14 +221,14 @@ Compliance Checklist https://cs203compliance.duckdns.org
224221

225222
Note: If you encounter a NetworkError while on SMU Wi-Fi, switch to another network (DNS blocking issue).
226223

227-
##🧱 Backend Testing Requirements
224+
## 🧱 Backend Testing Requirements
228225
Ensure Docker Desktop is running before executing tests:
229226

230-
bash
231-
Copy code
227+
```bash
232228
docker ps
233229
mvn test
230+
```
234231
If Docker is not running, integration tests will fail.
235232

236-
###⭐ Trade Optimization Pathfinder (TOP) —
233+
### ⭐ Trade Optimization Pathfinder (TOP) —
237234
Empowering global trade through transparent, explainable, and optimized tariff intelligence.

0 commit comments

Comments
 (0)