Add READMEs for remaining packages
- db-schema: Database schema types from kysely-codegen - db: Database client and helper functions - testing: Overview of testing packages - test-helpers: Database testing utilities - virtual-authenticator: WebAuthn virtual authenticator Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
34
packages/testing/README.md
Normal file
34
packages/testing/README.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# Testing Packages
|
||||
|
||||
Shared testing utilities for the RevIQ platform.
|
||||
|
||||
## Packages
|
||||
|
||||
### @reviq/test-helpers
|
||||
|
||||
Database testing utilities including test database setup, transactions, and fixtures.
|
||||
|
||||
```typescript
|
||||
import { createTestDb, withTestTransaction, describeE2E } from "@reviq/test-helpers";
|
||||
```
|
||||
|
||||
### @reviq/virtual-authenticator
|
||||
|
||||
WebAuthn virtual authenticator for testing passkey flows without real hardware.
|
||||
|
||||
```typescript
|
||||
import { VirtualAuthenticator } from "@reviq/virtual-authenticator";
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
These packages are used internally for e2e and integration tests. Add them as dev dependencies:
|
||||
|
||||
```json
|
||||
{
|
||||
"devDependencies": {
|
||||
"@reviq/test-helpers": "workspace:*",
|
||||
"@reviq/virtual-authenticator": "workspace:*"
|
||||
}
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user