bunny-lab/Borealis-Github-Replica
1
0
Fork 0
mirror of https://github.com/bunny-lab-io/Borealis.git synced 2025-09-10 23:08:43 -06:00
Code Issues Packages Projects Releases Wiki Activity

Updated Readme

Browse Source
This commit is contained in:
Nicole Rappe
2025-09-03 01:45:52 -06:00
parent 0f57f866fb
commit 98161b6875
1 changed files with 40 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
readme.md
View File

@@ -1,24 +1,28 @@
![Borealis Logo](https://github.com/bunny-lab-io/Borealis/blob/main/Data/Server/WebUI/public/Borealis_Logo_Full.png) ![Borealis Logo](https://github.com/bunny-lab-io/Borealis/blob/main/Data/Server/WebUI/public/Borealis_Logo_Full.png)
# Borealis: Visual Automation For Everyone
**Borealis** is an all-in-one visual automation studio. **Borealis** is an all-in-one visual automation studio.
Whether you want to automate data flows, control a computer, extract data from images, or connect to APIs and webhooks, Borealis turns these advanced tasks into a simple, visual drag-and-drop experience. Whether you want to automate data flows, control a computer, extract data from images, or connect to APIs and webhooks, Borealis turns these advanced tasks into a simple, visual drag-and-drop experience.
Borealis began as a visual node-graph builder. It is now evolving into a centralized remote management and automation platform that still embraces visual workflows, while prioritizing fleet orchestration, inventory, and scripted automations at-scale. Items marked (*roadmap*) indicate forward-looking capabilities under active design.
## Youtube Video Demonstration: ## Youtube Video Demonstration:
You can click the image below to watch a youtube video demonstrating the deployment, launching, and basic example usage of Borealis. You can click the image below to watch a youtube video demonstrating the deployment, launching, and basic example usage of Borealis.
[![Borealis Usage Demonstration](Data/Repository_Resources/data_workflow_example_01.png)](https://www.youtube.com/watch?v=6GLolR70CTo) [![Borealis Usage Demonstration](Data/Repository_Resources/data_workflow_example_01.png)](https://www.youtube.com/watch?v=6GLolR70CTo)
## 🚀 What Is Borealis? ## 🚀 What Is Borealis?
Imagine building automations and powerful data workflows by *connecting blocks on a canvas* — and having them come to life in real time. Borealis is a cross-platform, live-editable automation tool that makes it possible to create, test, and run workflows with **zero coding required** (unless you want to). Imagine building automations and powerful data workflows by *connecting blocks on a canvas* - and having them come to life in real time. Borealis is a cross-platform, live-editable automation tool that makes it possible to create, test, and run workflows with **zero coding required** (unless you want to).
Beyond the canvas, Borealis is growing into a centralized control-plane for remote device management and automation (*roadmap*). The canvas remains your design surface, while remote agents and a management console coordinate inventory, policy, and script execution across fleets.
Borealis combines: Borealis combines:
* **A powerful visual graph editor** (built with React Flow) * **A powerful visual graph editor** (built with React Flow)
* **A real-time backend server** (Python Flask + WebSockets) * **A real-time backend server** (Python Flask *or* Vite + WebSockets)
* **Optional Python Agent** for advanced computer automation (screenshot, overlays, and more) * **Optional Python Agent** for advanced computer automation (screenshot, overlays, and more)
* **Live node updates, instant feedback, no restarts required** * **Live node updates, instant feedback, no restarts required**
* **Emerging remote agent fleet** for Windows/Linux/macOS management (*roadmap*)
* **Central management console** for inventory, targeting, and job orchestration (*roadmap*)
--- ---
@@ -35,8 +39,12 @@ Borealis combines:
| **Data Ingestion & Manipulation** | Ingest data from files, APIs, manual input, or other sources — then filter, search, transform, or export it | | **Data Ingestion & Manipulation** | Ingest data from files, APIs, manual input, or other sources — then filter, search, transform, or export it |
| **API Requests & Webhooks** | Talk to REST APIs, integrate with web services, and hook Borealis into other tools | | **API Requests & Webhooks** | Talk to REST APIs, integrate with web services, and hook Borealis into other tools |
| **Extensible Node Library** | Add your own custom nodes or use the included library for data, images, math, logic, reporting, and more | | **Extensible Node Library** | Add your own custom nodes or use the included library for data, images, math, logic, reporting, and more |
| **Undo & Resilience** | Made a mistake editing a node or the UI? No worries — just fix it and reload. Vite dev server makes changes appear instantly | | **Undo & Resilience** | Made a mistake editing a node or the UI? No worries - just fix it and reload. The included Vite dev server makes changes appear instantly |
| **Cross-Platform** | Works on Windows, Linux, macOS — one-click launch scripts included | | **Cross-Platform** | Works on Windows, Linux, macOS - one-click launch scripts included |
| **Centralized Management (roadmap)** | Manage agents, groups, policies, and jobs from one console |
| **Agent Inventory (roadmap)** | Collect device facts: installed software, OS, storage, networking, last logged-in user |
| **Script Orchestration (roadmap)** | Push/schedule PowerShell, Bash, Batch scripts and Ansible playbooks with outputs and audit trails |
| **Compliance & Audit (roadmap)** | Define baselines, detect drift, and export reports for fleet state |
--- ---
@@ -48,21 +56,35 @@ Borealis combines:
* **Computer Automation:** Trigger keypresses, capture screens, and even run scheduled macros * **Computer Automation:** Trigger keypresses, capture screens, and even run scheduled macros
* **APIs & Webhooks:** Build visual flows that connect to any REST API, fetch data, and process responses * **APIs & Webhooks:** Build visual flows that connect to any REST API, fetch data, and process responses
* **Real-Time Dashboards:** Build custom, live-updating dashboards by wiring together data nodes and viewers * **Real-Time Dashboards:** Build custom, live-updating dashboards by wiring together data nodes and viewers
* **Rapid Prototyping:** Instantly test ideas — drop in new nodes, see your changes live, and never fear breaking things * **Rapid Prototyping:** Instantly test ideas - drop in new nodes, see your changes live, and never fear breaking things
* **Remote Fleet Automations (*roadmap*):** Run scripts/playbooks across targeted devices, roll out changes safely at scale
* **Inventory & Auditing (*roadmap*):** Query installed software, OS versions, storage/networking, and last logged-in activity
* **Runbook Automation (*roadmap*):** Design visual runbooks in the canvas and execute them remotely with approvals and logging
--- ---
## 🏆 Why Borealis Stands Out ## 🏆 Why Borealis Stands Out
* **Instant Feedback:** Every change is live. No need to restart — just drag, connect, or edit and see results instantly. * **Instant Feedback:** Every change is live. No need to restart — just drag, connect, or edit and see results instantly.
* **No Fear Development:** Messed up a node file? UI won’t crash; just fix the file, save, and Borealis will hot-reload it. * **No Fear Development:** Messed up a node file? UI won't crash; just fix the file, save, and Borealis will hot-reload it.
* **Beginner Friendly:** If you can use a mouse, you can use Borealis. But it grows with you as you learn. * **Beginner Friendly:** If you can use a mouse, you can use Borealis. But it grows with you as you learn.
* **Unified Canvas + Control Plane (*roadmap*):** Design visually, orchestrate remotely, and observe everything from a single place.
--- ---
## 🔭 Future Potential (What Borealis Could Become) ## 🔭 Future Potential (What Borealis Could Become)
Borealis is already a swiss-army knife in the works — but here’s just a taste of what’s coming, or at-least possible, thanks to its modular, node-based design: Borealis is already a swiss-army knife in the works - but here's just a taste of what's coming, or at-least possible, thanks to its modular, node-based design:
As Borealis pivots toward centralized remote management, these *roadmap* items lead the way:
* **Centralized Remote Management (*roadmap*):** Unified console for device inventory, status, tagging, grouping, and targeting.
* **Script & Playbook Distribution (*roadmap*):** Deploy and run PowerShell, Bash, Batch, and Ansible playbooks across fleets; collect outputs and act upon them in meaningful ways.
* **Inventory & Insights (*roadmap*):** Agents report installed software, OS details, storage, networking, users (e.g., last logged-in), and custom facts.
* **Policy & Compliance (*roadmap*):** Define desired state baselines, detect drift, and trigger remediation workflows.
* **Governance & Safety (*roadmap*):** RBAC, approvals, change windows, versioned script catalog, and secrets management.
* **Event-Driven Automations (*roadmap*):** Triggers from inventory changes, schedules, or webhooks to run workflows or scripts.
* **Scalable Orchestration (*roadmap*):** Target by groups/tags/queries, staggered rollouts, retries, and robust job auditing.
* **Smart Automation:** Automatically detect patterns, trigger workflows from email, websites, or events. * **Smart Automation:** Automatically detect patterns, trigger workflows from email, websites, or events.
* **Machine Learning Nodes:** Drag-and-drop AI tasks — run models, analyze data, or classify images/text. * **Machine Learning Nodes:** Drag-and-drop AI tasks — run models, analyze data, or classify images/text.
@@ -81,7 +103,9 @@ Borealis is already a swiss-army knife in the works — but here’s just a tast
2. **Each node** does something — like reading a file, fetching an API, or processing an image. 2. **Each node** does something — like reading a file, fetching an API, or processing an image.
3. **Live data flows** through the graph in real time. Change a value? Every downstream node updates automatically. 3. **Live data flows** through the graph in real time. Change a value? Every downstream node updates automatically.
4. **The shared “Value Bus”** means nodes always see the latest data. No refreshes needed. 4. **The shared “Value Bus”** means nodes always see the latest data. No refreshes needed.
5. **Power-users and developers** can add their own nodes, or tweak the UI, with changes appearing instantly — even if you make a mistake. 5. **Power-users and developers** can add their own nodes, or tweak the UI, with changes appearing instantly - even if you make a mistake.
6. **Agents report facts (*roadmap*):** Lightweight agents send inventory and telemetry back to the server.
7. **Control-plane orchestrates jobs (*roadmap*):** Target devices by groups/tags and run scripts/playbooks with audit trails.
--- ---
@@ -95,6 +119,7 @@ Borealis is already a swiss-army knife in the works — but here’s just a tast
* **Reporting Nodes:** Export to CSV (*work-in-progress*) (future: other formats). * **Reporting Nodes:** Export to CSV (*work-in-progress*) (future: other formats).
* **API/Web Nodes:** API requests, regex, text manipulation, etc. * **API/Web Nodes:** API requests, regex, text manipulation, etc.
* **Organization Nodes:** Grouping/backdrop for neat, readable graphs. (*work-in-progress*) * **Organization Nodes:** Grouping/backdrop for neat, readable graphs. (*work-in-progress*)
* **Remote Action Nodes:** Dispatch and track script/playbook runs across agents (*roadmap*).
--- ---
@@ -103,6 +128,7 @@ Borealis is already a swiss-army knife in the works — but here’s just a tast
* **Automation geeks** who want a real-time, visual playground * **Automation geeks** who want a real-time, visual playground
* **Data analysts** who want to prototype and visualize data flows * **Data analysts** who want to prototype and visualize data flows
* **Developers** who want a safe, forgiving testbed for new ideas * **Developers** who want a safe, forgiving testbed for new ideas
* **IT admins / SREs (*roadmap focus*):** Centralize fleet inventory, enforce policy, and orchestrate scripted changes at scale
--- ---
@@ -111,15 +137,15 @@ Borealis is already a swiss-army knife in the works — but here’s just a tast
1. **Download Borealis** 1. **Download Borealis**
2. **Run the launcher:** 2. **Run the launcher:**
* Windows: `Borealis.ps1` * Windows: `.\Borealis.ps1`
* Linux/macOS: `Borealis.sh` * Linux/macOS: `bash Borealis.sh`
3. **Open the web UI** in your browser. Start building! 3. **Open the web UI** in your browser.
--- ---
## 🎁 Borealis Is Just Getting Started ## 🎁 Borealis Is Just Getting Started
Borealis is **more than a tool** — it’s a playground, a laboratory, and a future-proof platform for any automation you can imagine. Its best features are still ahead, and you can help shape them. Borealis is **more than a tool** - As the platform pivots toward centralized remote management, expect deeper inventory, script orchestration (PowerShell/Bash/Batch/Ansible), and governance-first workflows to land over time (*roadmap*).
**Start automating your ideas, today.** **Start automating your ideas, today.**