Flow-Frame

Flow-Frame is an advanced automation platform designed to orchestrate complex workflows involving AI, media processing, browser interactions, and email management.

It acts as a central nervous system for automation, connecting LLMs (OpenAI) with real-world interfaces (Gmail, Chrome, File System) and heavy computation tasks (Image/Audio processing).

🚀 Quick Start

1. Install Dependencies:
``bash
npm install
`
2. Setup Environment:
Create a .env file with your API keys.
3. Start Server:
`bash
npm start
`

🧪 Testing

This project uses Jest for unit and integration testing.

$3


To run the automated test suite:
`bash
npm test
`

$3

- Place unit tests alongside source files (e.g., src/utils.test.ts).
- Tests should use import syntax (ESM).
- Existing manual testing scripts (e.g. *.manual-test.ts) are excluded from the automated runner.

📚 Documentation

Detailed documentation is available in the docs/ folder:

- Setup & Installation: Configuration including src/config.json and GCP.
- Architecture: System design, services, and resiliency.
- API Reference: Endpoints for workflows, config files, media.
- Browser Automation: robotjs integration and extension details.
- Email Automation: Gmail polling and filtering.
- Workflows: How to build and run workflows.

🌟 Key Features

- Agentic UI Planning: Deeply integrated AI that maps web pages and uses robotjs to simulate human clicks and typing.
- Dynamic Workflows: Can materialize file structures from JSON and execute them (build-workflow.js).
- Production Resilience: Global error handlers prevent server crashes (server.js).
- Media Pipeline: Native support for processing Audio, Images, and PDFs.

📂 Project Structure

- src/server.js: Main entry point with error handling.
- src/operations.js: Low-level OS automation (mouse/keyboard).
- src/configEndpoints.js: API for managing file-based configs.
- src/services/: Business logic and AI services.
- src/extension/: Chrome extension for browser integration.
- src/gmail-poller/`: Email automation tools.

License

Private / Proprietary.