Skip to content

Updating documentation to match the current state of project - #72

Open
Sunilshah-7 wants to merge 8 commits into
mainfrom
config
Open

Updating documentation to match the current state of project#72
Sunilshah-7 wants to merge 8 commits into
mainfrom
config

Conversation

@Sunilshah-7

Copy link
Copy Markdown
Collaborator

Summary

Code changes

  1. backend/app.py — backend now binds port 8010 instead of Flask's default 5000 (macOS AirPlay Receiver occupies 5000); added a sync-note comment
  2. frontend/services/api.ts — API_BASE_URL → http://127.0.0.1:8010/; added a sync-note comment
  3. frontend/components/mainScreen.tsx — updated the commented-out base URL to 8010 so it doesn't mislead
  4. backend/tests/test_dpga_real_positives.py — ST_URL_ENDPOINT → 8010

Dependency fixes

  1. models/requirements.txt — removed fastapi, uvicorn, pydantic (never imported); added flask, sentence-transformers, numpy (imported but missing). Installing it previously produced a service that couldn't start.
  2. backend/requirements.txt — removed the spurious pipeline package (pipeline comes from transformers)

Configuration

  1. .env.example— added the missing HF_TOKEN; marked required vs. optional; added token-guide links
  2. .gitignore— added models/venv/ and .pytest_cache/

Documentation

  1. CONTRIBUTING.md
  • Setup rewritten as a three-service walkthrough with a service/port table and an explicit "no root package.json" warning
  • Fixed the three broken steps: npm install, cp .env.example .env, npm run dev at root
  • Prerequisites gained Python 3.10+/venv/pip; Node floor corrected v18 → v18.18; Groq/HF tokens marked optional
  • Added the previously undocumented models/ service (port 9010, slow first start) and bash.sh
  • npm test → pytest tests/ (backend) and npm run lint (frontend), linking docs/TESTING.md
  • "Passes all CI checks" corrected — no CI pipeline exists
  • Coding Standards: cd frontend && npm run lint; dropped the nonexistent npm run format
  1. CLAUDE.md — models/ corrected from FastAPI to Flask; noted /similarities is unused; recorded the new backend port

Verification performed

  1. Backend test suite: 96 passed
  2. Confirmed no live references to port 5000 remain
  3. Confirmed models/venv/ is now correctly ignored and both .env.example files remain trackable

Signed-off-by: Sunil Shah <sunilshah2416@gmail.com>
…anging port from 5000 to 8010

Signed-off-by: Sunil Shah <sunilshah2416@gmail.com>
…anging port from 5000 to 8010

Signed-off-by: Sunil Shah <sunilshah2416@gmail.com>
… contributing file in readme

Signed-off-by: Sunil Shah <sunilshah2416@gmail.com>
Signed-off-by: Sunil Shah <sunilshah2416@gmail.com>
Signed-off-by: Sunil Shah <sunilshah2416@gmail.com>
Signed-off-by: Sunil Shah <sunilshah2416@gmail.com>
Signed-off-by: Sunil Shah <sunilshah2416@gmail.com>
@Sunilshah-7

Sunilshah-7 commented Aug 21, 2026

Copy link
Copy Markdown
Collaborator Author

New updates:

  • Fixed missing type import in cardGrid.tsx — production build now passes
  • Moved hardcoded API address out of frontend/services/api.ts into NEXT_PUBLIC_API_BASE_URL
  • Moved hardcoded model service address out of embedding_url.py into MODEL_SERVICE_URL
  • Made both service ports env-driven (BACKEND_PORT, MODELS_PORT)
  • Created frontend/.env.example and documented all new variables in root .env.example
  • Added .env loading to models/app.py (plus os import and python-dotenv dependency)
  • Removed dead commented-out code containing another hardcoded address in mainScreen.tsx
  • Env-driven the endpoint in the manual test_dpga_real_positives.py script
  • Turned off debug=True in backend/app.py — now off by default, opt-in via FLASK_DEBUG, with a startup warning
  • Pinned debug=False in models/app.py so the shared .env can't switch it on there

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant