@@ -11,7 +11,7 @@ RAG on PostgreSQL is a Python FastAPI backend with React TypeScript frontend tha
1111Install the following tools before beginning development:
1212
1313- ** Python 3.10+** (3.12 recommended)
14- - ** Node.js 18+** for frontend development
14+ - ** Node.js 18+** for frontend development
1515- ** PostgreSQL 14+** with pgvector extension
1616- ** Azure Developer CLI (azd)** for deployment
1717- ** Docker Desktop** for dev containers (optional)
@@ -37,7 +37,7 @@ Run these commands in sequence. NEVER CANCEL any long-running commands:
3737 ``` bash
3838 # Ubuntu/Debian:
3939 sudo apt update && sudo apt install -y postgresql-16-pgvector
40-
40+
4141 # Start PostgreSQL and set password
4242 sudo service postgresql start
4343 sudo -u postgres psql -c " ALTER USER postgres PASSWORD 'postgres'"
@@ -97,7 +97,7 @@ Use "Frontend & Backend" configuration in the VS Code Run & Debug menu.
9797### Linting and Formatting (ALWAYS run before committing)
9898``` bash
9999ruff check . # Lint code (takes <1 second)
100- ruff format . # Format code (takes <1 second)
100+ ruff format . # Format code (takes <1 second)
101101mypy . --python-version 3.12 # Type check (takes ~42 seconds)
102102```
103103
@@ -121,7 +121,7 @@ pytest tests/e2e.py --tracing=retain-on-failure
121121** CRITICAL TIMING INFORMATION** - Set these timeout values and NEVER CANCEL:
122122
123123- ** Dependencies install** : 90 seconds (use 180+ second timeout)
124- - ** Frontend npm install** : 22 seconds (use 60+ second timeout)
124+ - ** Frontend npm install** : 22 seconds (use 60+ second timeout)
125125- ** Frontend build** : 12 seconds (use 30+ second timeout)
126126- ** MyPy type checking** : 42 seconds (use 90+ second timeout)
127127- ** Full test suite** : 25 seconds (use 60+ second timeout)
@@ -156,7 +156,7 @@ pytest tests/e2e.py --tracing=retain-on-failure
156156 # Test API endpoints
157157 curl http://localhost:8000/items/1
158158 # Should return JSON with item data
159-
159+
160160 # Test frontend
161161 curl http://localhost:8000/ | head -n 5
162162 # Should return HTML with "RAG on PostgreSQL" title
@@ -226,9 +226,6 @@ The application supports multiple OpenAI providers:
2262263 . ** Ollama** (local):
227227 Set ` OPENAI_CHAT_HOST=ollama `
228228
229- 4 . ** GitHub Models** :
230- Set ` OPENAI_CHAT_HOST=github `
231-
232229## Common Issues and Solutions
233230
234231### Database Connection Issues
@@ -267,7 +264,7 @@ Open `http://localhost:8089/` and point to your running application.
267264The application provides these REST API endpoints (view full docs at ` http://localhost:8000/docs ` ):
268265
269266- ` GET /items/{id} ` - Get specific item by ID
270- - ` GET /search ` - Search items with text query
267+ - ` GET /search ` - Search items with text query
271268- ` GET /similar ` - Find similar items using vector search
272269- ` POST /chat ` - Chat with RAG system (requires OpenAI configuration)
273270- ` POST /chat/stream ` - Streaming chat responses
@@ -286,7 +283,7 @@ curl "http://localhost:8000/search?query=tent&limit=5"
286283** Quick ls -la output for repository root:**
287284```
288285.devcontainer/ # Dev container configuration
289- .env.sample # Environment variables template
286+ .env.sample # Environment variables template
290287.github/ # GitHub Actions workflows
291288.gitignore # Git ignore patterns
292289.pre-commit-config.yaml # Pre-commit hook configuration
@@ -309,8 +306,8 @@ tests/ # Test suite
309306- ** Always build and test locally before committing**
310307- ** Use pre-commit hooks** - they run ruff automatically
311308- ** Check the GitHub Actions** in ` .github/workflows/ ` for CI requirements
312- - ** Reference the full README.md** for deployment and Azure-specific details
309+ - ** Reference the full README.md** for deployment and Azure-specific details
313310- ** Use VS Code with the Python and Ruff extensions** for the best development experience
314311- ** Never skip the frontend build** - the backend serves static files from ` src/backend/static/ `
315312
316- This project follows modern Python and TypeScript development practices with comprehensive tooling for code quality, testing, and deployment.
313+ This project follows modern Python and TypeScript development practices with comprehensive tooling for code quality, testing, and deployment.
0 commit comments