Skip to content

Commit 9f2487c

Browse files
docs: Add service verification steps to LocalDevelopmentSetup
Added verification steps for backend and frontend services, including terminal status checklist and common issues.
1 parent 70e6371 commit 9f2487c

File tree

1 file changed

+49
-1
lines changed

1 file changed

+49
-1
lines changed

docs/LocalDevelopmentSetup.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,6 +310,8 @@ chmod +x start.sh
310310

311311
## Step 6: Running Backend and Frontend Separately
312312

313+
> **📋 Terminal Reminder**: This section requires **two separate terminal windows** - one for the Backend API and one for the Frontend. Keep both terminals open while running. All commands assume you start from the **repository root directory**.
314+
313315
#### Step 1: Create Virtual Environment (Recommended)
314316

315317
Open your terminal and navigate to the root folder of the project, then create the virtual environment:
@@ -374,6 +376,52 @@ python -m uvicorn app:app --port 50505 --reload
374376
375377
The App will run on `http://127.0.0.1:50505/#/` by default.
376378

379+
## Step 7: Verify All Services Are Running
380+
381+
Before using the application, confirm all services are running correctly:
382+
383+
### Terminal Status Checklist
384+
385+
| Terminal | Service | Command | Expected Output | URL |
386+
|----------|---------|---------|-----------------|-----|
387+
| **Terminal 1** | Backend API | `python -m uvicorn app:app --port 50505 --reload` | `INFO: Application startup complete` | http://127.0.0.1:50505 |
388+
| **Terminal 2** | Frontend (Dev) | `npm run dev` | `Local: http://localhost:5173/` | http://localhost:5173 |
389+
390+
### Quick Verification
391+
392+
**1. Check Backend API:**
393+
```bash
394+
# In a new terminal
395+
curl http://127.0.0.1:50505/health
396+
# Expected: {"status":"healthy"} or similar JSON response
397+
```
398+
399+
**2. Check Frontend:**
400+
- Open browser to http://127.0.0.1:50505 (production build) or http://localhost:5173 (dev server)
401+
- Should see the Document Generation UI
402+
- If authentication is configured, you'll be redirected to Azure AD login
403+
404+
### Common Issues
405+
406+
**Service not starting?**
407+
- Ensure you're in the correct directory (`src/` for backend)
408+
- Verify virtual environment is activated (you should see `(.venv)` in prompt)
409+
- Check that port is not already in use (50505 for API, 5173 for frontend dev)
410+
- Review error messages in the terminal
411+
412+
**Can't access services?**
413+
- Verify firewall isn't blocking ports 50505 or 5173
414+
- Try `http://localhost:port` instead of `http://127.0.0.1:port`
415+
- Ensure services show "startup complete" messages
416+
417+
## Step 8: Next Steps
418+
419+
Once all services are running (as confirmed in Step 7), you can:
420+
421+
1. **Access the Application**: Open `http://127.0.0.1:50505` in your browser to explore the Document Generation UI
422+
2. **Explore Sample Questions**: Follow [SampleQuestions.md](SampleQuestions.md) for example prompts and use cases
423+
3. **Understand the Architecture**: Review the codebase starting with `src/backend/` directory
424+
377425
## Troubleshooting
378426

379427
### Common Issues
@@ -458,4 +506,4 @@ cat .env | grep -v '^#' | grep '=' # Should show key=value pairs
458506
- [Delete Resource Group](DeleteResourceGroup.md) - Steps to safely delete the Azure resource group created for the solution.
459507
- [App Authentication Setup](AppAuthentication.md) - Guide to configure application authentication and add support for additional platforms.
460508
- [Powershell Setup](PowershellSetup.md) - Instructions for setting up PowerShell and required scripts.
461-
- [Quota Check](QuotaCheck.md) - Steps to verify Azure quotas and ensure required limits before deployment.
509+
- [Quota Check](QuotaCheck.md) - Steps to verify Azure quotas and ensure required limits before deployment.

0 commit comments

Comments
 (0)