Skip to content

Virgo-Alpha/Sentinel

Repository files navigation

Sentinel - AI-Powered News Monitoring System

A comprehensive AWS-based solution for monitoring news feeds, analyzing content with AI, and providing real-time alerts based on configurable keywords and criteria.

Quick Start

To replicate this project, follow the documentation in order:

📚 Documentation Order

Follow these documents sequentially to set up the complete system:

  1. 01-project-overview.md - Understanding the system architecture and components
  2. 02-deployment-guide.md - Complete deployment instructions
  3. 03-deployment-checklist.md - Pre-deployment verification steps
  4. 04-lambda-deployment.md - Lambda functions deployment
  5. 05-amplify-deployment.md - Frontend application deployment
  6. 06-article-ingestion.md - Setting up news feed ingestion
  7. 07-verification-testing.md - System verification and testing
  8. 08-configuration-management.md - System configuration
  9. 09-operations-runbook.md - Day-to-day operations
  10. 10-troubleshooting.md - Common issues and solutions

🔧 Post-Deployment Guides

After successful deployment, refer to these for ongoing management:

  1. 11-user-guide.md - End-user instructions
  2. 12-user-access-control.md - Managing user permissions
  3. 13-keyword-management.md - Configuring monitoring keywords
  4. 14-scaling-guide.md - Scaling the system
  5. 15-cost-optimization.md - Optimizing AWS costs
  6. 16-disaster-recovery.md - Backup and recovery procedures
  7. 17-configuration-examples.md - Sample configurations

🚀 Automated Deployment

Deploy Everything at Once

cd scripts
./deploy-all-stacks.sh

Deploy Individual Stacks

cd scripts

# Deploy in order:
./deploy-core-stack.sh          # Core infrastructure
./deploy-storage-stack.sh       # DynamoDB, S3, etc.
./deploy-backend-stack.sh       # Lambda functions, SQS, etc.
./deploy-ai-stack.sh           # Bedrock AI services
./deploy-api-auth-stack.sh     # API Gateway, Cognito

# Then deploy application components:
./deploy-all-lambdas.sh        # All Lambda functions
./deploy-complete-amplify.sh   # Frontend application

Validation

cd scripts
./validate-deployment.sh       # Verify all components
./validate-system.sh          # End-to-end testing

📁 Project Structure

├── cloudformation/           # CloudFormation templates
├── scripts/                 # Deployment and utility scripts
├── docs/                   # Documentation (follow in order)
├── lambda/                 # Lambda function source code
├── amplify-app/           # Frontend React application
└── README.md              # This file

🛠️ Prerequisites

  • AWS CLI configured with appropriate permissions
  • Node.js 18+ and npm
  • Python 3.9+ with pip
  • Bash shell environment

📋 Environment Variables

Set these before deployment:

export AWS_REGION=us-east-1
export ENVIRONMENT=dev  # or prod

🆘 Need Help?

  1. Check the troubleshooting guide
  2. Review the operations runbook
  3. Validate your deployment with the provided scripts

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.