fraim-framework 2.0.30 → 2.0.34

package/registry/workflows/replicate/website-discovery-analysis.md

@@ -1,231 +0,0 @@
-# Website Discovery & Analysis Workflow
-
-## Overview
-This workflow guides agents through systematically discovering, analyzing, and documenting an existing web application. This is the first critical phase when re-implementing an application from a live site.
-
-## Prerequisites
-- Access to the target website URL
-- Python 3.8 or higher
-- Basic understanding of web technologies (HTML, CSS, JavaScript, React)
-
-### Required Python Packages
-Install required packages:
-```bash
-pip install playwright beautifulsoup4 requests
-```
-
-For Playwright browser automation, you also need to install browser binaries:
-```bash
-playwright install chromium
-```
-
-## Workflow Steps
-
-### Phase 1: Initial Site Scraping
-
-**Objective**: Get a comprehensive understanding of the site structure, pages, and resources.
-
-1. **Run Basic Site Scraper**
-   ```bash
-   python <scrape-script> <target_url> [--max-pages N] [--output-dir DIR] [--output-file FILE]
-   ```
-   - **Options**:
-     - `target_url`: Base URL of the website to scrape (required)
-     - `--max-pages N`: Maximum number of pages to scrape (default: 50)
-     - `--output-dir DIR`: Output directory for results (default: current directory)
-     - `--output-file FILE`: Output filename (default: site_analysis.json)
-   - This will:
-     - Discover all pages on the site
-     - Extract HTML structure
-     - Identify CSS and JavaScript files
-     - Find all forms and inputs
-     - Map internal and external links
-     - Generate `site_analysis.json` containing page structure, forms, CSS/JS files, images, and links
-
-2. **Review Initial Findings**
-   - Check `site_analysis.json` for:
-     - Total pages discovered
-     - Common navigation patterns
-     - Form structures
-     - Resource dependencies
-
-### Phase 2: Interactive Browser Analysis
-
-**Objective**: Understand dynamic behavior, user interactions, and React/SPA patterns.
-
-1. **Run Interactive Explorer**
-   ```bash
-   python <interactive-explorer-script> <target_url> [--output-dir DIR] [--headless] [--max-clicks N]
-   ```
-   - **Options**:
-     - `target_url`: Base URL of the website to explore (required)
-     - `--output-dir DIR`: Output directory for results (default: current directory)
-     - `--headless`: Run browser in headless mode
-     - `--max-clicks N`: Maximum number of clicks to perform (default: 20)
-   - This will:
-     - Navigate through all pages
-     - Click buttons and links
-     - Capture screenshots of each state
-     - Identify React components and routing
-     - Document user flows
-     - Generate `interaction_analysis.json` (containing pages visited, interactions performed, screenshots taken, use case hints) and screenshots in `screenshots/` directory
-
-2. **Review Screenshots**
-   - Organize screenshots by page/feature
-   - Document visual patterns and UI components
-   - Identify navigation flows
-
-### Phase 3: Comprehensive Content Analysis
-
-**Objective**: Deep dive into all content, extract use cases, and understand functionality.
-
-1. **Run Comprehensive Explorer**
-   ```bash
-   python <comprehensive-explorer-script> <target_url> [--output-dir DIR] [--headless]
-   ```
-   - **Options**:
-     - `target_url`: Base URL of the website to explore (required)
-     - `--output-dir DIR`: Output directory for results (default: current directory)
-     - `--headless`: Run browser in headless mode
-   - This will:
-     - Explore all discovered routes
-     - Extract detailed page content
-     - Identify use cases from content analysis
-     - Generate comprehensive report
-     - Create `comprehensive_analysis.json` (containing detailed page content, all discovered routes, comprehensive use case analysis, page structure analysis) and screenshots in `screenshots/` directory
-
-2. **Manual Review & Validation**
-   - Open the site in a browser
-   - Manually navigate through all features
-   - Verify automated findings
-   - Document any missed features
-
-### Phase 4: Use Case Extraction
-
-**Objective**: Systematically identify and document all user workflows and use cases.
-
-1. **Analyze Collected Data**
-   - Review all JSON reports
-   - Identify user roles (volunteer, organization, admin)
-   - Map user journeys
-   - Document feature sets
-
-2. **Create Use Case Document**
-   - Use template: `templates/replicate/use-cases-template.md`
-   - For each use case, document:
-     - **Name**: Clear, descriptive name
-     - **Actor**: Who performs this action
-     - **Preconditions**: What must be true before
-     - **Steps**: Detailed step-by-step workflow
-     - **Postconditions**: Expected outcomes
-     - **Screenshots**: Reference to relevant screenshots
-     - **Priority**: High/Medium/Low
-
-3. **Validate Completeness**
-   - Check that all pages have associated use cases
-   - Ensure all forms have documented workflows
-   - Verify all navigation paths are covered
-   - Confirm all user roles are represented
-
-### Phase 5: Structure Documentation
-
-**Objective**: Document the application architecture and structure.
-
-1. **Create Structure Document**
-   - Document:
-     - Page hierarchy and routing
-     - Component relationships
-     - Data models (inferred from forms)
-     - API endpoints (inferred from forms and interactions)
-     - User roles and permissions
-
-2. **Create Visual Inventory**
-   - Organize screenshots by:
-     - Page/Route
-     - Feature/Use Case
-     - User Role
-   - Create screenshot index document
-
-## Output Artifacts
-
-After completing this workflow, you should have:
-
-1. **Data Files**:
-   - `site_analysis.json` - Basic site structure
-   - `interaction_analysis.json` - Interactive behavior
-   - `comprehensive_analysis.json` - Deep content analysis
-
-2. **Screenshots**:
-   - Organized in `screenshots/` directory
-   - Named with descriptive prefixes
-   - Cover all pages and key interactions
-
-3. **Documentation**:
-   - `USE_CASES_AND_SCREENSHOTS_REPORT.md` - Complete use case documentation
-   - `SITE_ANALYSIS_REPORT.md` - Site structure and architecture
-   - `SCREENSHOT_INDEX.md` - Index of all screenshots with descriptions
-
-## Best Practices
-
-1. **Be Thorough**: Don't skip pages or features. Every page should be analyzed.
-
-2. **Document Everything**: When in doubt, document it. Better to have too much information than too little.
-
-3. **Validate Manually**: Automated tools are helpful but manual review is essential.
-
-4. **Organize Early**: Keep screenshots and documents organized from the start.
-
-5. **Iterate**: Discovery is iterative. You may need to run scripts multiple times as you discover new routes.
-
-## Common Challenges
-
-1. **SPA Routing**: React/SPA apps may not expose all routes in HTML. Use browser navigation to discover routes.
-
-2. **Authentication**: Some pages may require login. Document login flows separately.
-
-3. **Dynamic Content**: Content loaded via JavaScript may not appear in initial HTML. Use browser automation.
-
-4. **Rate Limiting**: Be respectful with request frequency. Scripts include delays.
-
-## Troubleshooting
-
-### Browser Installation Issues
-If Playwright browser installation fails:
-```bash
-playwright install chromium --force
-```
-
-### Import Errors
-If you get import errors, ensure all packages are installed:
-```bash
-pip install --upgrade playwright beautifulsoup4 requests
-```
-
-### Network Timeouts
-If scripts timeout:
-- Check your internet connection
-- Verify the target URL is accessible
-- Increase timeout values in the script if needed
-
-### Best Practices for Scripts
-1. **Be Respectful**: Include delays between requests to avoid overwhelming the target server
-2. **Start Small**: Use `--max-pages` or `--max-clicks` to limit initial exploration
-3. **Review Outputs**: Manually review JSON outputs and screenshots to validate findings
-4. **Organize Results**: Use consistent output directories to keep analysis organized
-
-**Important Notes**:
-- These scripts are specialized tools for website replication/migration projects
-- They require Python and Playwright dependencies
-- Use these scripts responsibly and respect robots.txt and terms of service
-- Consider rate limiting and be respectful of server resources
-
-## Next Steps
-
-After completing this workflow, proceed to:
-- **Re-implementation Strategy** workflow (`workflows/replicate/re-implementation-strategy.md`)
-- **Use Case-Driven Testing** workflow (`workflows/testing/use-case-driven-testing.md`)
-
-## Related Workflows
-- `workflows/replicate/use-case-extraction.md`
-- `workflows/replicate/visual-analysis.md`
-- `workflows/replicate/re-implementation-strategy.md`

package/sample_package.json

@@ -1,18 +0,0 @@
-{
-    "scripts": {
-      "build": "tsc",
-      "dev": "npx tsx --watch src/server.ts > server.log 2>&1",
-      "test": "set EXCLUDE_TAGS=baml,flaky,failing&& npx tsx --test --test-concurrency=1 --test-reporter tap %npm_config_test% > test.log 2>&1",
-      "test-smoke": "set TAGS=smoke&& npx tsx --test --test-concurrency=1 --test-reporter tap %npm_config_test% > test.log 2>&1",
-      "test-smoke-ci": "set TAGS=smoke&& npx tsx --test --test-concurrency=1 --test-reporter tap test*.ts",
-      "test-flaky": "set TAGS=flaky&& npx tsx --test --test-concurrency=1 --test-reporter tap %npm_config_test% > test.log 2>&1",
-      "test-failing": "set TAGS=failing&& npx tsx --test --test-concurrency=1 --test-reporter tap %npm_config_test% > test.log 2>&1",
-      "test-baml": "set TAGS=baml&& npx tsx --test --test-concurrency=1 --test-reporter tap %npm_config_test% > test.log 2>&1",
-      "test-all": "tsx --test --test-concurrency=1 --test-reporter tap",
-      "test-all-ci": "set EXCLUDE_TAGS=flaky,failing&& tsx --test --test-concurrency=1 --test-reporter tap test*.ts",
-      "generate": "baml-cli generate",
-      "lint": "eslint *.ts",
-      "lint:fix": "eslint *.ts --fix"
-    }
-  }
-