Skip to content

ramailo1/FlowForge

Repository files navigation

Here's a more professional and polished version of your README file for FlowForge:


FlowForge Chrome Extension

FlowForge is a powerful Chrome extension that learns your browsing habits, suggests automations, and helps you perform repetitive web tasks with a single click.


🔧 Features

1. Smart Browsing Sequence Detection

  • Automatically tracks step-by-step navigation patterns across websites.
  • Identifies and groups repeated sequences into actionable "Flows".
  • Ensures user privacy by storing all data locally on your device.

2. Intelligent Automation Suggestions

  • Detects repeated flows (3+ occurrences) and offers to create shortcuts via prompt cards.
  • Uses machine learning to identify similar—but not identical—patterns.
  • Supports custom trigger conditions such as URL patterns and time of day.

3. One-Click Task Execution

  • Provides a simple popup UI with icons, descriptions, and "Run" buttons.
  • Automates multi-step tasks by sequentially loading pages and waiting for full load before continuing.
  • Reduces manual effort for frequent tasks like report generation, data entry, or website monitoring.

4. Data Privacy & Control

  • All Flow data is stored using chrome.storage.local, with no external transmission.
  • Features include "Clear History" and an optional encryption setting.
  • 100% local processing ensures maximum data privacy.

5. Cross-Device Synchronization

  • Sync your Flows and settings across devices using Chrome’s Sync Storage API.
  • Maintain a consistent experience and workflow regardless of which machine you're on.
  • Includes improved reliability with cloud-backed storage enhancements.

🚀 Installation

Via Chrome Web Store

(Link coming soon)

  1. Visit the Chrome Web Store page for FlowForge.
  2. Click Add to Chrome to install.

Manual Installation (Developer Mode)

  1. Clone or download this repository.
  2. Open Chrome and navigate to chrome://extensions/.
  3. Enable Developer mode in the top-right corner.
  4. Click Load unpacked and select the root directory of FlowForge.

📘 Usage Guide

Getting Started

FlowForge runs in the background and automatically starts tracking your browsing patterns. A small badge in the bottom-right corner indicates when tracking is active.

Creating Flows

  • Automatic Detection: When a repeated browsing pattern is detected (3+ repetitions), FlowForge will suggest creating a Flow.
  • Manual Creation: Click the FlowForge icon in your toolbar and select New Flow to define one manually.

Managing Flows

  1. Click the FlowForge icon in your Chrome toolbar.
  2. View, search, and filter your saved Flows.
  3. Click Run to execute a Flow.
  4. Click the settings icon on a Flow card to rename, delete, or edit it.

Options Page

Access the full settings panel via the extension popup:

  • Flows: View and manage your saved Flows.
  • Settings: Adjust extension behavior and preferences.
  • Data Management: Export, import, encrypt, or clear your data.
  • About: Version info and credits.

🛠 Technical Overview

FlowForge is developed using:

  • Manifest V3 for modern Chrome extension support.
  • Background Service Worker for event-based flow detection and execution.
  • Content Scripts to overlay UI elements and interact with web pages.
  • Chrome Storage API (local and sync) for data persistence.

🔒 Privacy & Security

FlowForge is designed with privacy at its core:

  • No data is ever transmitted to external servers.
  • All browsing and Flow data is stored locally.
  • Users have full control over data, including encryption and deletion options.

🤝 Contributing

We welcome contributions! If you'd like to improve FlowForge, feel free to:

  • Submit a pull request
  • Report issues
  • Suggest new features

🛠 Development

Prerequisites

  • Node.js v16+
  • Chrome browser

Setup

npm install

Testing

npm test

Building

npm run build

🗺 Roadmap

v1.1 (Upcoming)

  • Enhanced flow detection algorithms
  • Cross-browser support (Firefox, Edge)
  • Cloud sync backup option

v1.2 (Planned)

  • Mobile companion app
  • Advanced scheduling options
  • Team collaboration features

📄 License

This project is licensed under the MIT License.

About

Learn and automate your browsing sequences across websites

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published