Skip to content

create, manage, and notify your community about your Github workflows with a few clicks

License

Notifications You must be signed in to change notification settings

Chelseasingla1/flow-forge

 
 

Repository files navigation

🌟 About

Flow-Forge is your one-stop solution to optimize GitHub workflows. With features like repository orchestration, automated issue management, and streamlined PR reviews, Flow-Forge turns chaotic workflows into seamless clockwork operations.

🎥 Demo

$~$

🚀 Deployment

  • Kestra: Deployed on an Azure Virtual Machine.
  • Flow-Forge Next.js App: Deployed on Vercel.

$~$

📊 Workflow

kestra

$~$

📂 Features

  1. GitHub Workflow Monitoring
    Track workflow statuses (success, failure, in-progress) with GitHub API integration.

  2. Automated Issue Creation
    Automatically generate detailed GitHub issues for failed workflows.

  3. Real-Time Notifications
    Receive instant alerts on Discord and Slack for workflow updates.

  4. Email Notifications
    Detailed workflow failure alerts via email for extended team reach.

  5. Orchestration with Kestra
    Handle multiple repositories and workflows with task automation.

$~$

🛠️ Setup and Configuration

Prerequisites

  • GitHub PAT: Required for API access.
  • Discord/Slack Webhooks: Notification channels setup.
  • Azure VM: Deployment platform for backend services.
  • Node.js & npm: Runtime and package manager.

Installation Steps

  1. Clone Repository

    git clone <repo-url>
    cd ci-cd-manager
  2. Install Dependencies

    npm install
  3. Configure Environment Variables Add a .env.local file with:

    GITHUB_TOKEN=<your_token>
    DISCORD_WEBHOOK_URL=<webhook_url>
    SLACK_WEBHOOK_URL=<webhook_url>
    
  4. Build Application

    npm run build
  5. Deploy on Azure VM

    • Transfer project files to VM.
    • Start the app with PM2:
      pm2 start npm --name "flow-forge" -- start

$~$

📑 Documentation Highlights

CI/CD Manager Overview

Flow-Forge simplifies continuous integration and delivery with:

  • Workflow status tracking.
  • Automated notifications.
  • Intuitive dashboard interfaces.

Key Features

  • GitHub Issue Automation
    Automates logging failed workflows.

  • Discord and Slack Integration
    Real-time alerts for quick issue resolution.

  • Kestra Workflow Integration
    Visual workflow design for managing orchestration tasks.

$~$

📄 License

This project is licensed under the MIT License.
You can find the full text of the license here.

$~$

🧑‍🤝‍🧑 Our List of Contributors

About

create, manage, and notify your community about your Github workflows with a few clicks

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 97.7%
  • CSS 1.5%
  • JavaScript 0.8%