Skip to content

Commit 6ddbd9a

Browse files
committed
docs: update README with tree-style project directory structure
1 parent 54fec61 commit 6ddbd9a

1 file changed

Lines changed: 47 additions & 46 deletions

File tree

README.md

Lines changed: 47 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -48,55 +48,56 @@ Each scenario validates real user interactions, UI consistency, business logic,
4848
---
4949

5050

51-
## Project Structure
52-
53-
5451

5552
### Project Structure
5653

57-
- **.env**: Environment variables (API keys, etc.)
58-
- **.env.example**: Example env file for sharing
59-
- **.gitignore**: Git ignore rules
60-
- **.github/**: GitHub workflows & configs
61-
- **ai/**: AI test generator scripts
62-
- generate_generic_tests_ai.js
63-
- **allure-results/**: Allure reporting artifacts
64-
- **apiresponse/**: API response artifacts
65-
- **artifacts/**: Locator maps, screenshots, logos
66-
- **components/**: UI components (Navbar, Footer, Card, QuickActions)
67-
- **config/**: App and test configuration
68-
- **doc/**: Documentation articles (component testing, XState, Playwright comparison, etc.)
69-
- **hooks/**: Test hooks (before/after logic)
70-
- **learning-path.md**: Step-by-step learning path and test categories
71-
- **node_modules/**: Node.js dependencies
72-
- **pages/**: Page Object Model (POM) for all app pages
73-
- **playwright-ct.config.js**: Playwright component test config
74-
- **playwright-fixtures.js**: Custom Playwright fixtures (screenshots, video)
75-
- **playwright-report/**: Playwright HTML reports
76-
- **playwright.config.js**: Playwright configuration
77-
- **prompts/**: Prompt templates for AI test generation
78-
- playwright_login_test_generation.txt
79-
- playwright_test_generation.txt
80-
- **README-ai.md**: AI-powered test generation details
81-
- **README.md**: Main project documentation
82-
- **reports/**: Test run reports, MCP artifacts
83-
- **screenshots/**: Screenshots for tests
84-
- **test-results/**: Screenshots, videos & traces (auto-generated)
85-
- **testdata/**: CSV files for data-driven tests
86-
- login_data.csv
87-
- e2e_login_data.csv
88-
- **tests/**: Test specifications
89-
- advanced/
90-
- api/
91-
- components/
92-
- device/
93-
- e2e/
94-
- mcp/
95-
- smoke/
96-
- **uitestengine/**: Test context and base classes
97-
- **utils/**: Utilities (actions, data, waits, etc.)
98-
- **package.json**: Project dependencies and scripts
99-
- **LICENSE**: License file
54+
```
55+
K11TechLab-playwright-javascript-ai-augmented-framework/
56+
57+
├── .env # Environment variables (API keys, etc.)
58+
├── .env.example # Example env file for sharing
59+
├── .gitignore # Git ignore rules
60+
├── .github/ # GitHub workflows & configs
61+
├── ai/ # AI test generator scripts
62+
│ └── generate_generic_tests_ai.js
63+
├── allure-results/ # Allure reporting artifacts
64+
├── apiresponse/ # API response artifacts
65+
├── artifacts/ # Locator maps, screenshots, logos
66+
├── components/ # UI components (Navbar, Footer, Card, QuickActions)
67+
├── config/ # App and test configuration
68+
├── doc/ # Documentation articles (component testing, XState, Playwright comparison, etc.)
69+
├── hooks/ # Test hooks (before/after logic)
70+
├── learning-path.md # Step-by-step learning path and test categories
71+
├── node_modules/ # Node.js dependencies
72+
├── pages/ # Page Object Model (POM) for all app pages
73+
├── playwright-ct.config.js # Playwright component test config
74+
├── playwright-fixtures.js # Custom Playwright fixtures (screenshots, video)
75+
├── playwright-report/ # Playwright HTML reports
76+
├── playwright.config.js # Playwright configuration
77+
├── prompts/ # Prompt templates for AI test generation
78+
│ ├── playwright_login_test_generation.txt
79+
│ └── playwright_test_generation.txt
80+
├── README-ai.md # AI-powered test generation details
81+
├── README.md # Main project documentation
82+
├── reports/ # Test run reports, MCP artifacts
83+
├── screenshots/ # Screenshots for tests
84+
├── test-results/ # Screenshots, videos & traces (auto-generated)
85+
├── testdata/ # CSV files for data-driven tests
86+
│ ├── login_data.csv
87+
│ └── e2e_login_data.csv
88+
├── tests/ # Test specifications
89+
│ ├── advanced/
90+
│ ├── api/
91+
│ ├── components/
92+
│ ├── device/
93+
│ ├── e2e/
94+
│ ├── mcp/
95+
│ └── smoke/
96+
├── uitestengine/ # Test context and base classes
97+
├── utils/ # Utilities (actions, data, waits, etc.)
98+
├── package.json # Project dependencies and scripts
99+
└── LICENSE # License file
100+
```
100101

101102
---
102103

0 commit comments

Comments
 (0)