Skip to content

Commit 7f9482a

Browse files
Update README.md
1 parent 2ff0dad commit 7f9482a

1 file changed

Lines changed: 0 additions & 48 deletions

File tree

README.md

Lines changed: 0 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,8 @@
22

33
AI-powered cloud security tool that scans AWS environments for common misconfigurations and vulnerabilities. It provides actionable insights and even command-level fixes using LLMs to enhance cloud security with minimal setup.
44

5-
## Features
6-
7-
- **AI-Powered Security Platform**: Built with Go (Gin) and Python (FastAPI) backends, and React.js/Next.js frontend
8-
- **AWS Service Scanners**: Comprehensive security analysis for IAM, EC2, S3, Lambda, DynamoDB, and ECS
9-
- **LLM-Based Remediation**: Automated command-line fixes for misconfigurations using DSPy for robust structures on unreliable LLM outputs
10-
- **GraphQL API**: Real-time security scanning and vulnerability management with PostgreSQL database
11-
- **Docker Deployment**: Multi-environment support (development/production)
12-
- **Extensible Architecture**: Supports multiple cloud providers with role-based access control
13-
- **SaaS Functionality**: Authentication middleware and Stripe payment webhook integration
14-
155
## Quick Start
166

17-
### Prerequisites
18-
19-
- Docker 24+
20-
- Docker Compose v2+
21-
- 8GB RAM minimum
22-
237
### Setup
248

259
1. Clone the repository:
@@ -45,35 +29,3 @@ Services will be available at:
4529
- **Kestra**: http://localhost:8081 - AI Agent Orchestration
4630
- **Neo4j Browser**: http://localhost:7474 - Security Graph (user: neo4j, password: from .env)
4731
- **PostgreSQL**: localhost:5432 - Metadata & Results
48-
49-
## Development & Testing
50-
51-
### End-to-End (E2E) Testing with AI
52-
53-
We provide a comprehensive E2E test suite that runs against **LocalStack** (simulating AWS) and the **AI Service**.
54-
55-
1. **Prerequisites**:
56-
- Docker & Docker Compose
57-
- Go 1.21+ (for running tests locally)
58-
- (Optional) OpenAI API Key for real AI summaries
59-
60-
2. **Run Full AI Demo**:
61-
This single command starts the entire stack, creates 20+ misconfigured AWS resources (S3, EC2, IAM, Lambda, DynamoDB), runs the security scanner, and validates the AI summaries and remediation commands.
62-
63-
```bash
64-
cd backend/api
65-
export OPENAI_API_KEY=sk-your-key # Optional
66-
make e2e-ai-demo
67-
```
68-
69-
**What happens:**
70-
- Starts LocalStack, Postgres, Neo4j, and Python AI Service
71-
- Simulates a compromised AWS environment with 20+ vulnerabilities
72-
- Runs the Go Scanner via `SecurityService`
73-
- AI Agent analyzes findings and generates specific **AWS CLI remediation commands**
74-
- Verifies the GraphQL API response includes these summaries
75-
76-
3. **Cleanup**:
77-
```bash
78-
make e2e-ai-down
79-
```

0 commit comments

Comments
 (0)