SCGR commited on
Commit
202b784
Β·
1 Parent(s): 60b6623
Files changed (2) hide show
  1. .github/workflows/e2e.yml +2 -2
  2. README.md +55 -16
.github/workflows/e2e.yml CHANGED
@@ -32,7 +32,7 @@ jobs:
32
 
33
  - name: Start E2E environment
34
  run: |
35
- docker-compose -f e2e/docker-compose.e2e.yml up -d --build
36
 
37
  - name: Wait for services to be ready
38
  run: |
@@ -75,4 +75,4 @@ jobs:
75
  - name: Cleanup E2E environment
76
  if: always()
77
  run: |
78
- docker-compose -f e2e/docker-compose.e2e.yml down -v
 
32
 
33
  - name: Start E2E environment
34
  run: |
35
+ docker compose -f e2e/docker-compose.e2e.yml up -d --build
36
 
37
  - name: Wait for services to be ready
38
  run: |
 
75
  - name: Cleanup E2E environment
76
  if: always()
77
  run: |
78
+ docker compose -f e2e/docker-compose.e2e.yml down -v
README.md CHANGED
@@ -9,19 +9,58 @@ pinned: false
9
  ---
10
 
11
  # PromptAid Vision
12
- AI-powered crisis map analysis platform using Vision Language Models.
13
-
14
- ## Features
15
- - Crisis map/drone imagery analysis
16
- - Explore & export database
17
- - Analytics dashboard
18
-
19
- ## Tech Stack
20
- Backend: FastAPI (Python 3.11)
21
- Frontend: React + TS
22
- Database: PostgreSQL (use external DB in Spaces)
23
- Storage: S3-compatible (use external service)
24
- Models: OpenAI / Gemini / HF
25
-
26
- ## Env Vars
27
- DATABASE_URL, S3_ENDPOINT, S3_ACCESS_KEY, S3_SECRET_KEY, S3_BUCKET, OPENAI_API_KEY, GOOGLE_API_KEY, HF_API_KEY
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9
  ---
10
 
11
  # PromptAid Vision
12
+
13
+ A comprehensive vision analysis platform for crisis mapping and drone image processing.
14
+
15
+ ## Testing
16
+
17
+ ### Frontend Tests
18
+ - **Unit Tests**: `frontend/src/test/unit_tests/` - Component and hook testing with Vitest
19
+ - **Integration Tests**: `frontend/src/test/integration/` - Component interaction testing
20
+
21
+ ### Backend Tests
22
+ - **Unit Tests**: `py_backend/tests/unit_tests/` - Individual service testing
23
+ - **Integration Tests**: `py_backend/tests/integration_tests/` - API and workflow testing
24
+
25
+ ### End-to-End Tests
26
+ - **E2E Tests**: `e2e/` - Complete user workflow testing with Playwright
27
+ - **CI/CD**: `.github/workflows/e2e.yml` - Automated E2E testing pipeline
28
+
29
+ ## Quick Start
30
+
31
+ ### Development
32
+ ```bash
33
+ # Frontend
34
+ cd frontend
35
+ npm install
36
+ npm run dev
37
+
38
+ # Backend
39
+ cd py_backend
40
+ pip install -r requirements.txt
41
+ uvicorn app.main:app --reload
42
+ ```
43
+
44
+ ### Testing
45
+ ```bash
46
+ # Frontend tests
47
+ cd frontend
48
+ npm run test:unit
49
+ npm run test:integration
50
+
51
+ # Backend tests
52
+ cd py_backend
53
+ python -m pytest tests/
54
+
55
+ # E2E tests
56
+ cd e2e
57
+ ./run_e2e_tests.sh
58
+ ```
59
+
60
+ ## Project Structure
61
+ ```
62
+ β”œβ”€β”€ frontend/ # React + TypeScript
63
+ β”œβ”€β”€ py_backend/ # FastAPI + Python
64
+ β”œβ”€β”€ e2e/ # End-to-end tests
65
+ └── .github/workflows/ # CI/CD pipelines
66
+ ```