Aryan Mishra commited on
Commit
dc0b93e
·
1 Parent(s): 1e71331

docs: clean up README architecture and startup instructions

Browse files
Files changed (1) hide show
  1. README.md +6 -10
README.md CHANGED
@@ -25,9 +25,9 @@ The system leverages state-of-the-art models like **XLM-RoBERTa** and **IndicBER
25
  ## Python-First Architecture
26
 
27
  This repository is designed following a **Python-first paradigm**:
28
- - **Python (67.5%)**: Handling all business logic, data processing, configuration, API routing, ML inference, and utility functions using FastAPI and Python data science libraries.
29
- - **JavaScript/TypeScript (32.5%)**: Strictly limited to the frontend `dashboard/` directory, used *only* for the Alpine.js for minimal client-side state.
30
- - *Note: There is no backend or ML logic written in JavaScript.*
31
 
32
  ## Repository Structure
33
 
@@ -92,16 +92,12 @@ dvc push # Push newly generated artifacts to remote
92
 
93
  ### 4. Running the Application Locally
94
 
95
- **Start the API Server:**
96
  ```bash
97
  PYTHONPATH=. uvicorn api.app.main:app --reload --host 0.0.0.0 --port 8000
98
  ```
99
- *API Documentation will be available at `http://localhost:8000/docs`.*
100
-
101
- **Start the Dashboard:**
102
- ```bash
103
- ```
104
- *Access the dashboard at `http://localhost:8000/predict`.*
105
 
106
  ## How it Works
107
 
 
25
  ## Python-First Architecture
26
 
27
  This repository is designed following a **Python-first paradigm**:
28
+ - **Python (99%)**: Handling all business logic, data processing, configuration, API routing, ML inference, SSR (Server-Side Rendering) via Jinja2, and utility functions.
29
+ - **JavaScript (1%)**: Strictly limited to Alpine.js for minimal client-side interactivity and Chart.js for visualization (loaded via CDN).
30
+ - *Note: There is no decoupled SPA frontend (like React) or Node.js runtime required.*
31
 
32
  ## Repository Structure
33
 
 
92
 
93
  ### 4. Running the Application Locally
94
 
95
+ **Start the Application Server (API & Dashboard):**
96
  ```bash
97
  PYTHONPATH=. uvicorn api.app.main:app --reload --host 0.0.0.0 --port 8000
98
  ```
99
+ - Access the dashboard at: `http://localhost:8000/predict`
100
+ - API Documentation available at: `http://localhost:8000/docs`
 
 
 
 
101
 
102
  ## How it Works
103