Skip to content

Commit 2a350de

Browse files
committed
Update README.md with latest project structure and folders
1 parent 4c30dd0 commit 2a350de

1 file changed

Lines changed: 43 additions & 107 deletions

File tree

README.md

Lines changed: 43 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -27,89 +27,6 @@ Explore the `README-ai.md` for details on AI test generation and advanced featur
2727

2828

2929

30-
## ✨ Framework Highlights
31-
32-
- Page Object Model (POM) for clean UI abstraction
33-
- Component-level tests for React (QuickActions, Card, HeroCarousel)
34-
- Parallel test execution for fast feedback
35-
- E2E flows and advanced user journeys
36-
- Network mocking and request interception for robust test scenarios
37-
- Visual regression testing for UI and component screenshots
38-
- Custom Playwright fixture: saves screenshots for every test and individual card
39-
- Allure and HTML reporting for rich test evidence
40-
- Video capture for selected tests
41-
- Config-driven navigation and robust selectors
42-
- CI/CD friendly, scalable structure
43-
- Documentation articles in /doc (component testing, Playwright JS/TS/Python comparison)
44-
45-
46-
## 📁 Project Structure
47-
48-
```
49-
.env
50-
.env.example
51-
.gitignore
52-
ai/
53-
allure-results/
54-
apiresponse/
55-
artifacts/
56-
components/
57-
config/
58-
doc/
59-
hooks/
60-
learning-path.md
61-
node_modules/
62-
pages/
63-
playwright-ct.config.js
64-
playwright-fixtures.js
65-
playwright-report/
66-
playwright.config.js
67-
prompts/
68-
README-ai.md
69-
README.md
70-
reports/
71-
screenshots/
72-
test-results/
73-
testdata/
74-
tests/
75-
uitestengine/
76-
utils/
77-
```
78-
79-
### Key Test Categories
80-
- `tests/smoke/` – Smoke tests
81-
- `tests/e2e/` – End-to-end flows
82-
- `tests/components/` – Component-level tests
83-
- `tests/api/` – API tests
84-
- `tests/mcp/` – Model Context Protocol (MCP) tests
85-
- `tests/advanced/` – Advanced scenarios
86-
- `tests/device/` – Device-specific tests
87-
88-
### Documentation
89-
- `doc/` – Articles and guides (component testing, XState, Playwright comparison, etc.)
90-
- `learning-path.md` – Step-by-step learning path and test categories
91-
- `README-ai.md` – AI-powered test generation details
92-
93-
### Prompts & AI
94-
- `prompts/` – Prompt templates for AI test generation
95-
- `ai/generate_generic_tests_ai.js` – AI test generator script
96-
97-
### Artifacts & Reports
98-
- `artifacts/` – Screenshots, visual regression, logos
99-
- `reports/` – Test run reports, MCP artifacts
100-
101-
### Utilities
102-
- `utils/` – Element actions, Excel utilities, reusable helpers
103-
104-
### Config
105-
- `config/` – Centralized app configuration
106-
107-
### Test Data
108-
- `testdata/` – CSV files for data-driven tests
109-
110-
---
111-
112-
11330
## 🧪 Automated Test Scenarios
11431

11532

@@ -131,8 +48,6 @@ Each scenario validates real user interactions, UI consistency, business logic,
13148
---
13249

13350

134-
## 🧪 Automated Test Scenarios
135-
13651

13752
## 🧩 Tech Stack
13853

@@ -146,38 +61,59 @@ Each scenario validates real user interactions, UI consistency, business logic,
14661
---
14762

14863

64+
14965
## 🏗️ Project Structure
15066

15167
```
15268
K11TechLab-playwright-javascript-ai-augmented-framework/
15369
154-
├── .github/ # GitHub workflows & configs
155-
├── artifacts/ # Locator maps and test artifacts
156-
├── components/ # UI components (Navbar, Footer, Card, QuickActions)
157-
├── config/ # App and test configuration
158-
├── hooks/ # Test hooks (before/after logic)
159-
├── pages/ # Page Object Model (POM) for all app pages
160-
├── tests/ # Test specifications (smoke, regression, lab, component)
161-
├── uitestengine/ # Test context and base classes
162-
├── utils/ # Utilities (actions, data, waits, etc.)
70+
├── .env # Environment variables (API keys, etc.)
71+
├── .env.example # Example env file for sharing
72+
├── .gitignore # Git ignore rules
73+
├── .github/ # GitHub workflows & configs
74+
├── ai/ # AI test generator scripts
75+
│ └── generate_generic_tests_ai.js
76+
├── allure-results/ # Allure reporting artifacts
77+
├── apiresponse/ # API response artifacts
78+
├── artifacts/ # Locator maps, screenshots, logos
79+
├── components/ # UI components (Navbar, Footer, Card, QuickActions)
80+
├── config/ # App and test configuration
81+
├── doc/ # Documentation articles (component testing, XState, Playwright comparison, etc.)
82+
├── hooks/ # Test hooks (before/after logic)
83+
├── learning-path.md # Step-by-step learning path and test categories
84+
├── node_modules/ # Node.js dependencies
85+
├── pages/ # Page Object Model (POM) for all app pages
86+
├── playwright-ct.config.js # Playwright component test config
16387
├── playwright-fixtures.js # Custom Playwright fixtures (screenshots, video)
164-
├── doc/ # Documentation articles (component testing, Playwright comparison)
165-
├── playwright.config.js # Playwright configuration
166-
├── test-results/ # Screenshots, videos & traces (auto-generated)
167-
├── allure-results/ # Allure reporting artifacts
168-
├── playwright-report/ # Playwright HTML reports
169-
├── package.json
170-
└── README.md
88+
├── playwright-report/ # Playwright HTML reports
89+
├── playwright.config.js # Playwright configuration
90+
├── prompts/ # Prompt templates for AI test generation
91+
│ ├── playwright_login_test_generation.txt
92+
│ └── playwright_test_generation.txt
93+
├── README-ai.md # AI-powered test generation details
94+
├── README.md # Main project documentation
95+
├── reports/ # Test run reports, MCP artifacts
96+
├── screenshots/ # Screenshots for tests
97+
├── test-results/ # Screenshots, videos & traces (auto-generated)
98+
├── testdata/ # CSV files for data-driven tests
99+
│ ├── login_data.csv
100+
│ └── e2e_login_data.csv
101+
├── tests/ # Test specifications
102+
│ ├── advanced/
103+
│ ├── api/
104+
│ ├── components/
105+
│ ├── device/
106+
│ ├── e2e/
107+
│ ├── mcp/
108+
│ └── smoke/
109+
├── uitestengine/ # Test context and base classes
110+
├── utils/ # Utilities (actions, data, waits, etc.)
111+
├── package.json # Project dependencies and scripts
112+
└── LICENSE # License file
171113
```
172114

173115
---
174116

175-
176-
177-
178-
179-
test('K11softwaresolutions.com Home Page UI and Navigation screenshot', async ({ page }) => {
180-
181117
## 🧪 Sample Test Flows
182118

183119
### E2E Test Example

0 commit comments

Comments
 (0)