docs

QA Studio Documentation

Welcome to the QA Studio documentation! This directory contains comprehensive guides for setup, development, and security.

📚 Table of Contents

Deployment

• DEPLOYMENT.md - Production deployment (Vercel, Docker, VPS, env vars, cron jobs)
• DOCKER.md - Docker Compose development and operations

Features & Setup

• PRICING.md - Pricing plans and billing configuration
• STRIPE_SETUP.md - Payment and subscription setup (Pro plan)
• ENTERPRISE_SETUP.md - Enterprise plan admin panel and manual management
• TEAMS_AND_ROLES.md - Team structure and permissions
• TEAM_INVITATIONS.md - Inviting users to teams
• API_KEYS_SETUP.md - Setting up API keys for programmatic access

Integrations

• INTEGRATIONS.md - Third-party integrations setup and usage
• INTEGRATION_USAGE.md - Integration code examples

API & Development

• TESTING_FRAMEWORKS.md - Multi-framework testing support (Cypress, Jest, PyTest, etc.)
• PLAYWRIGHT_API_GUIDE.md - Playwright-specific integration guide
• REPORTER_API.md - Reporter API reference

Security

• SECURITY.md - Security implementation and best practices

---

🚀 Quick Start

Deploying QA Studio

1. Read DEPLOYMENT.md for Vercel, Docker, or Node.js hosting
2. For self-hosted unlimited features: SELF_HOSTED.md
3. For local Docker dev: DOCKER.md

Setting Up a New Development Environment

1. Configure pricing and billing: PRICING.md
2. Set up Stripe: STRIPE_SETUP.md
3. Configure API keys: API_KEYS_SETUP.md
4. Review security setup: SECURITY.md

Integrating Playwright Tests

1. Read PLAYWRIGHT_API_GUIDE.md
2. Check REPORTER_API.md for reporter setup

Working with Teams

1. Understand structure: TEAMS_AND_ROLES.md
2. Set up invitations: TEAM_INVITATIONS.md

Adding Integrations

1. Setup guide: INTEGRATIONS.md
2. Code examples: INTEGRATION_USAGE.md

---

📝 Contributing Documentation

When adding new documentation:

1. Place in /docs directory - All markdown docs should live here (blog posts live under src/md/blog/)

2. Update this README - Add your doc to the appropriate section

3. Use clear headings - Make docs easy to navigate

4. Include code examples - Show, don't just tell

5. Link related docs - Help users find related information

6. Run checks before committing - From the repo root:

   npm run format   # Required — Prettier must pass in CI (including markdown)
   npm run check    # Required when you change TypeScript or Svelte code

   Commit any files that npm run format updates. See CONTRIBUTING.md for the full workflow.

Documentation Standards

• Use relative links between docs
• Include a "Table of Contents" for long docs
• Add troubleshooting sections where applicable
• Keep security docs up to date with code changes

---

🔗 External Resources

• Main Project README
• Environment Variables
• Prisma Schema
• API Routes

---

Need help? Open an issue or contact the team.