omni-dashboard-playwright-reporter/README.md

Playwright client for publishing test results to Omni Dashboard - Transform Your Test Automation with AI-Powered Insights

# 🚀 omni dashboard playwright reporter
Transform Your Test Automation with AI-Powered Insights

## 📦 Installation

```bash
npm install
npm run build
```

## Publish to npm
1. Commit and push your changes to remote git repo
2. Minor patch 
```bash
npm version patch
npm publish
```


## 🔧 Configuration

1. Set up your environment variables:

```bash
export OMNI_DASHBOARD_PROJECT_ID=your_project_id_provided_by_testvagrant
export OMNI_DASHBOARD_API_KEY=your_api_key_provided_by_testvagrant
export OMNI_DASHBOARD_ENVIRONMENT=your_test_environment
```

2. Configure the reporter in your Playwright config file (`playwright.config.ts`):

```typescript
import { defineConfig } from '@playwright/test';

export default defineConfig({
  reporter: [
    ['html'],
    ['omni-dashboard-playwright-reporter']
  ],
  // ... rest of your config
});
```

## 🔐 Security

Your API key (OMNI_DASHBOARD_API_KEY) and project ID (OMNI_DASHBOARD_PROJECT_ID) are sensitive credentials. Always:
- Store them in environment variables
- Never commit them to version control


## 📚 Documentation

- **Architecture & Technical Details**: See [ARCHITECTURE.md](./ARCHITECTURE.md) for comprehensive documentation on:
  - Parallel execution handling
  - Performance optimizations
  - Error handling strategies
  - File-based coordination
  - Troubleshooting guide

- **API Reference**: Visit our [documentation site](https://omni.testvagrant.ai) for API details.