Update README.md

Author: pkeffect

README.md

@@ -33,17 +33,17 @@ A containerized development environment for testing and developing applications
 
 ## ✨ Features
 
-- **Cross-platform compatibility**: All services run in Docker containers
-- **Hot reloading**: All servers automatically reload when code changes
-- **Unified dashboard**: Monitor all services in one interface
-- **Standardized API endpoints**: Common patterns across all server implementations
-- **CORS enabled**: All services configured for cross-origin requests
-- **Health checks**: Docker health checks implemented for all services
-- **Reverse proxy (optional)**: Nginx configuration for unified routing
-- **API testing tools**: Scripts for validating service functionality
-- **Resource management**: Docker container resource limits for stable performance
-- **Git workflow**: Complete Git configuration with hooks, templates, and CI/CD
-- **Comprehensive CI/CD**: Automated testing and deployment with GitHub Actions
+- **📦 Cross-platform compatibility**: All services run in Docker containers
+- **🔄 Hot reloading**: All servers automatically reload when code changes
+- **📊 Unified dashboard**: Monitor all services in one interface
+- **🔌 Standardized API endpoints**: Common patterns across all server implementations
+- **🌐 CORS enabled**: All services configured for cross-origin requests
+- **💓 Health checks**: Docker health checks implemented for all services
+- **🔄 Reverse proxy (optional)**: Nginx configuration for unified routing
+- **🧪 API testing tools**: Scripts for validating service functionality
+- **💪 Resource management**: Docker container resource limits for stable performance
+- **🔀 Git workflow**: Complete Git configuration with hooks, templates, and CI/CD
+- **🚢 Comprehensive CI/CD**: Automated testing and deployment with GitHub Actions
 
 ## 🏗️ Architecture
 
@@ -120,30 +120,27 @@ The development environment consists of the following components:
 
 4. Build and start all services:
    ```bash
-   docker-compose up --build
+   docker compose up --build
    ```
 
 5. Access the dashboard:
    - Open your browser and navigate to [http://localhost:8081](http://localhost:8081)
 
 ## 🔌 Service Access Points
 
-<details>
-<summary>Click to expand all service endpoints</summary>
-
 - **Dashboard**: [http://localhost:8081](http://localhost:8081)
 - **Live Server API**: [http://localhost:8081/api.html](http://localhost:8081/api.html)
 - **Flask API**: [http://localhost:8082](http://localhost:8082)
+  - Documentation: [http://localhost:8082/docs](http://localhost:8082/docs)
 - **FastAPI**: [http://localhost:8083](http://localhost:8083)
   - OpenAPI Documentation: [http://localhost:8083/docs](http://localhost:8083/docs)
 - **Node.js Express**: [http://localhost:8084](http://localhost:8084)
+  - Swagger Documentation: [http://localhost:8084/docs](http://localhost:8084/docs)
 - **Unified Access** (if using Nginx): [http://localhost:8080](http://localhost:8080)
   - Flask API: [http://localhost:8080/flask](http://localhost:8080/flask)
   - FastAPI: [http://localhost:8080/fastapi](http://localhost:8080/fastapi)
   - Node.js: [http://localhost:8080/node](http://localhost:8080/node)
 
-</details>
-
 ## 💻 Development Workflow
 
 ### Project Structure
@@ -196,39 +193,10 @@ All code is mounted as volumes in the Docker containers, so changes to files wil
 - **Python**: Add to `requirements.txt` and restart the containers
 - **Node.js**: Add to `package.json` and restart the containers
 
-### Environment Variables
-
-Configure your development environment by editing the `.env` file:
-
-<details>
-<summary>View example environment configuration</summary>
-
-```
-# Server Configurations
-FLASK_ENV=development
-FLASK_DEBUG=1
-NODE_ENV=development
-
-# API Keys (for demonstration)
-DEMO_API_KEY=your_api_key_here
-
-# Database Configuration (if needed)
-DB_HOST=localhost
-DB_PORT=5432
-DB_NAME=devdb
-DB_USER=devuser
-DB_PASSWORD=devpassword
-```
-
-</details>
-
 ## 📝 API Documentation
 
 All services implement the following standard endpoints:
 
-<details>
-<summary>View API endpoints</summary>
-
 ### Root Endpoint
 
 ```
@@ -286,14 +254,12 @@ Response:
 }
 ```
 
-</details>
-
-### FastAPI Documentation
-
-FastAPI automatically generates interactive API documentation:
+### API Documentation Access
 
-- **Swagger UI**: [http://localhost:8083/docs](http://localhost:8083/docs)
-- **ReDoc**: [http://localhost:8083/redoc](http://localhost:8083/redoc)
+- **Flask**: [http://localhost:8082/docs](http://localhost:8082/docs)
+- **FastAPI**: [http://localhost:8083/docs](http://localhost:8083/docs)
+- **Node.js**: [http://localhost:8084/docs](http://localhost:8084/docs)
+- **Live Server**: [http://localhost:8081/api.html](http://localhost:8081/api.html)
 
 ## 🧪 Testing
 
@@ -305,9 +271,6 @@ The dashboard provides an interactive way to test all services:
 2. Click "Test" buttons for individual services
 3. Click "Test All Services" for a comprehensive check
 
-<details>
-<summary>View command line testing options</summary>
-
 ### Command Line Testing
 
 #### Bash Script
@@ -335,64 +298,55 @@ npm test
 
 ```bash
 # Run the Flask tests
-docker-compose exec flask-dev pytest tests/test_flask.py
+docker compose exec flask-dev pytest tests/test_flask.py
 
 # Run the FastAPI tests 
-docker-compose exec fastapi-dev pytest
+docker compose exec fastapi-dev pytest
 ```
 
-</details>
-
 ## 🐳 Managing Containers
 
-<details>
-<summary>View Docker management commands</summary>
-
 ### Starting Services
 
 ```bash
 # Start all services
-docker-compose up
+docker compose up
 
 # Start in detached mode
-docker-compose up -d
+docker compose up -d
 
 # Start a specific service
-docker-compose up flask-dev
+docker compose up flask-dev
 ```
 
 ### Stopping Services
 
 ```bash
 # Stop all services
-docker-compose down
+docker compose down
 
 # Stop and remove volumes
-docker-compose down -v
+docker compose down -v
 ```
 
 ### Viewing Logs
 
 ```bash
 # View logs from all services
-docker-compose logs
+docker compose logs
 
 # Follow logs
-docker-compose logs -f
+docker compose logs -f
 
 # View logs for a specific service
-docker-compose logs flask-dev
+docker compose logs flask-dev
 ```
 
-</details>
-
 ## 🚄 Performance Optimization
 
-This environment includes several performance optimizations:
-
-### FastAPI Resource Management
+### Resource Management
 
-The FastAPI service includes CPU and memory limits to prevent resource contention:
+The services include CPU and memory limits to prevent resource contention:
 
 ```yaml
 deploy:
@@ -405,65 +359,39 @@ deploy:
       memory: 128M
 ```
 
-### Uvicorn Worker Configuration
+### Worker Configuration
 
-For production deployments, the FastAPI service is configured with optimized worker settings:
+For production deployments, services can be configured with optimized worker settings:
 
 ```
 command: ["uvicorn", "app_fastapi:app", "--host", "0.0.0.0", "--port", "8080", "--workers", "1", "--log-level", "warning"]
 ```
 
-### Development vs. Production Settings
-
-For development, use the included hot-reload settings. For production, consider:
-
-1. Disabling hot-reload flags (`--reload`)
-2. Adjusting worker counts based on available CPU cores
-3. Setting appropriate logging levels
-
 ## 🔒 Security Considerations
 
 ### Container Security
 
-The Dockerfile includes commented sections for running containers as non-root users:
+The Dockerfile includes sections for running containers as non-root users:
 
 ```dockerfile
-# --- Create non-root user and group ---
+# Create non-root user and group
 RUN addgroup -S dev-group && adduser -S dev-user -G dev-group
 
-# --- Change ownership of the application directory ---
+# Change ownership of the application directory
 RUN chown -R dev-user:dev-group /app
 
-# --- Switch to the non-root user ---
+# Switch to the non-root user
 USER dev-user
 ```
 
 Uncomment these sections for improved container security in production.
 
 ### Environment Variables
 
-Ensure sensitive information is stored in `.env` files and never committed to version control. Update your `.gitignore` to exclude `.env` files:
-
-```
-# Environment variables
-.env
-.env.*
-!.env.example
-```
+Store sensitive information in `.env` files and never commit them to version control.
 
 ## 🔄 Git Configuration
 
-This project includes a complete Git workflow setup:
-
-- **`.gitignore`**: Comprehensive ignore patterns for development files
-- **`.gitattributes`**: Line ending normalization and file handling
-- **GitHub Workflows**: Automated CI/CD with GitHub Actions
-- **Issue & PR Templates**: Standardized formats for contributions
-- **Git Hooks**: Pre-commit validation for code quality
-
-<details>
-<summary>View Git setup instructions</summary>
-
 ### Setting Up Git Hooks
 
 ```bash
@@ -485,72 +413,36 @@ Follow the GitHub Flow branching strategy:
 
 For detailed instructions, see [GIT_SETUP.md](GIT_SETUP.md).
 
-</details>
-
 ## 🔧 Troubleshooting
 
-<details>
-<summary>View common issues and solutions</summary>
-
 ### Common Issues
 
 #### Service Not Starting
 
 Check the Docker logs:
 ```bash
-docker-compose logs [service-name]
+docker compose logs [service-name]
 ```
 
 #### Hot Reloading Not Working
 
 Ensure the correct volume mounts are in place and file permissions are correct:
 ```bash
-docker-compose down
-docker-compose up --build
+docker compose down
+docker compose up --build
 ```
 
 #### Cannot Access Service
 
 Verify the port mappings in `compose.yml` and check if the container is running:
 ```bash
-docker-compose ps
-```
-
-#### High CPU Usage in FastAPI
-
-If FastAPI is consuming excessive CPU resources, adjust the resource limits in `compose.yml` and consider disabling hot reload:
-
-```yaml
-command: ["uvicorn", "app_fastapi:app", "--host", "0.0.0.0", "--port", "8080", "--workers", "1", "--log-level", "warning"]
-deploy:
-  resources:
-    limits:
-      cpus: '0.5'
-      memory: 256M
+docker compose ps
 ```
 
-#### Live Server Test Failing
-
-Ensure the `src/api.html` file exists for the Live Server API endpoint. If the test still fails, check the browser console for CORS errors.
-
-#### CI Pipeline Failing
-
-Check the GitHub Actions logs for detailed error information. Common issues include:
-
-- Missing test files or incorrect paths
-- Import errors in Python tests
-- Timing issues with service startup
-
-### Health Checks
-
-Each service has built-in health checks that Docker uses to monitor container status:
-
-```bash
-# View container health
-docker ps
-```
+#### Debug Tools
 
-</details>
+Use the debug interface to diagnose connection issues:
+- [http://localhost:8081/debug.html](http://localhost:8081/debug.html)
 
 ## 👥 Contributing