LAP-30: Updated Readme.md and Design.md

Author: gurekam

DESIGN.md

@@ -24,9 +24,9 @@
 
 4. **Infrastructure Layer**
    - Containerization (Docker)
-   - Orchestration (Kubernetes)
-   - Monitoring
-   - Logging
+   - Orchestration (Amazon EKS)
+   - Monitoring (AWS CloudWatch)
+   - Logging (AWS CloudWatch Logs)
 
 ### Communication Flow
 
@@ -39,8 +39,8 @@
 2. **Inter-Service Communication**
    - Redis pub/sub for real-time updates
    - Database transactions
-   - Service discovery
-   - Load balancing
+   - Service discovery (EKS)
+   - Load balancing (AWS ELB)
 
 ## Sequence Diagrams
 
@@ -244,12 +244,11 @@ spreadsheetApplication/
 │   ├── utils/              # Utility functions
 │   └── app.py             # Main application
 ├── frontend/              # User interface
-├── kubernetes/           # Deployment configurations
+├── kubernetes/           # EKS deployment configurations
 ├── tests/               # Test suite
 ├── database/           # Local database storage
 ├── certs/             # SSL certificates
-├── .github/          # CI/CD workflows
-└── docs/            # Documentation
+└── docs/             # Documentation
 ```
 
 ## Deployment Architecture
@@ -290,4 +289,72 @@ spreadsheetApplication/
    - Error notifications
    - Performance alerts
    - Security alerts
-   - Capacity warnings 
+   - Capacity warnings
+
+## Infrastructure Design
+
+### Amazon EKS Architecture
+
+1. **Cluster Configuration**
+   - Managed node groups
+   - Auto-scaling groups
+   - Network policies
+   - Security groups
+
+2. **Deployment Strategy**
+   - Rolling updates
+   - Blue-green deployments
+   - Canary releases
+   - Rollback procedures
+
+3. **Resource Management**
+   - Resource quotas
+   - Pod resource limits
+   - Horizontal Pod Autoscaling
+   - Vertical Pod Autoscaling
+
+4. **Monitoring & Logging**
+   - CloudWatch metrics
+   - CloudWatch Logs
+   - Prometheus integration
+   - Grafana dashboards
+
+### CI/CD Pipeline
+
+1. **Source Control**
+   - Git repository
+   - Branch protection rules
+   - Code review requirements
+   - Automated testing
+
+2. **Build Process**
+   - Docker image building
+   - Security scanning
+   - Unit testing
+   - Integration testing
+
+3. **Deployment Process**
+   - AWS CodePipeline integration
+   - EKS deployment automation
+   - Environment promotion
+   - Rollback capabilities
+
+## Development Workflow
+
+1. **Issue Tracking**
+   - Project management
+   - Sprint planning
+   - Bug tracking
+   - Feature requests
+
+2. **Code Management**
+   - Git workflow
+   - Branch naming convention (feature/description)
+   - Commit message format (description)
+   - Pull request process
+
+3. **Quality Assurance**
+   - Automated testing
+   - Code review process
+   - Performance testing
+   - Security scanning

README.md

@@ -26,12 +26,6 @@ The Spreadsheet Application is a modern web-based solution for managing sales da
   - Session-based access control
   - Secure data transmission
 
-- **Deployment Options**
-  - Local development setup
-  - Docker containerization
-  - Kubernetes deployment
-  - CI/CD pipeline integration
-
 ## Technology Stack
 
 ### Frontend
@@ -47,12 +41,11 @@ The Spreadsheet Application is a modern web-based solution for managing sales da
 - **Real-time**: Flask-SocketIO 5.3+
 - **Security**: Werkzeug 3.0+
 
-### Development & Deployment
+### Infrastructure
 - **Containerization**: Docker
-- **Orchestration**: Kubernetes (Minikube)
-- **CI/CD**: GitHub Actions
-- **Code Quality**: Ruff, Pre-commit
-- **Environment**: Python 3.8+
+- **Orchestration**: Amazon EKS (Elastic Kubernetes Service)
+- **CI/CD**: AWS CodePipeline
+- **Monitoring**: AWS CloudWatch
 
 ## Getting Started
 
@@ -61,8 +54,10 @@ The Spreadsheet Application is a modern web-based solution for managing sales da
 - Python 3.8 or higher
 - Redis server
 - Git
-- Docker (optional)
-- Minikube (optional)
+- UV Package Manager
+- AWS CLI configured with appropriate credentials
+- kubectl configured for EKS cluster
+- eksctl for cluster management
 
 ### Installation
 
@@ -89,7 +84,7 @@ The Spreadsheet Application is a modern web-based solution for managing sales da
    ```
 
 4. **Configure Environment**
-   Create a `.env` file with:
+   Create a `.env` file in the root directory with:
    ```bash
    FLASK_APP=backend.app
    FLASK_ENV=development
@@ -98,9 +93,9 @@ The Spreadsheet Application is a modern web-based solution for managing sales da
    REDIS_PORT=6379
    ```
 
-## Deployment Options
+### Running the Application
 
-### Local Development
+#### Local Development
 
 1. **Start Redis Server**
    ```bash
@@ -119,33 +114,26 @@ The Spreadsheet Application is a modern web-based solution for managing sales da
 3. **Access Application**
    Open http://localhost:5000 in your browser
 
-### Docker Deployment
+#### EKS Deployment
 
-1. **Build Image**
+1. **Configure AWS CLI**
    ```bash
-   docker build -t spreadsheet-app .
+   aws configure
    ```
 
-2. **Run Container**
+2. **Create EKS Cluster**
    ```bash
-   docker run -p 5000:5000 spreadsheet-app
+   eksctl create cluster --name spreadsheet-app --region your-region --nodegroup-name standard-workers --node-type t3.medium --nodes 3 --nodes-min 1 --nodes-max 4 --managed
    ```
 
-### Kubernetes Deployment
-
-1. **Start Minikube**
-   ```bash
-   minikube start
-   ```
-
-2. **Deploy Application**
+3. **Deploy Application**
    ```bash
    kubectl apply -f kubernetes/
    ```
 
-3. **Access Application**
+4. **Access Application**
    ```bash
-   minikube service spreadsheet-app-service
+   kubectl get svc spreadsheet-app-service
    ```
 
 ## Project Structure
@@ -159,65 +147,33 @@ spreadsheetApplication/
 │   ├── utils/              # Utility functions
 │   └── app.py             # Main application
 ├── frontend/              # User interface
-├── kubernetes/           # Deployment configurations
-├── tests/               # Test suite
-├── database/           # Local database storage
-├── certs/             # SSL certificates
-├── .github/          # CI/CD workflows
-└── docs/            # Documentation
+├── kubernetes/           # EKS deployment configurations
+├── tests/                # Test suite
+├── database/            # Local database storage
+└── docs/               # Documentation
 ```
 
 ## Database Management
 
 The application uses DuckDB for data storage with the following features:
-- Local development: File-based storage
-- Production: Kubernetes persistent volume
+- File-based storage for local development
+- EKS persistent volume for production
 - Automatic schema management
 - Real-time data synchronization
 
-## CI/CD Pipeline
-
-The application uses GitHub Actions for continuous integration and deployment:
-
-1. **Testing Phase**
-   - Code linting and formatting
-   - Unit and integration tests
-   - Security scanning
-
-2. **Build Phase**
-   - Docker image creation
-   - Image scanning
-   - Push to Docker Hub
-
-3. **Deployment Phase**
-   - Kubernetes deployment
-   - Health checks
-   - Rollback capabilities
-
 ## Contributing
 
 We welcome contributions! Please follow these steps:
 
-1. Fork the repository
-2. Create a feature branch
-3. Make your changes
-4. Run tests and linting
-5. Submit a pull request
+1. Create a feature branch (`git checkout -b feature/feature-name`)
+2. Commit your changes (`git commit -m 'Add feature description'`)
+3. Push to the branch (`git push origin feature/feature-name`)
+4. Create a Pull Request
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the LICENSE file for details.
 
 ## Support
 
-For support, please:
-1. Check the [documentation](docs/)
-2. Open an issue on GitHub
-3. Contact the maintainers
-
-## Acknowledgments
-
-- Flask team for the web framework
-- Socket.IO for real-time capabilities
-- DuckDB for efficient data storage
-- Redis for session management
+For support, please contact the maintainers through the project's communication channels.