From 0ef7eec1157c8c5ce320ba3bf88b5e5f339a2e4e Mon Sep 17 00:00:00 2001 From: Nicole Rappe Date: Sun, 13 Apr 2025 19:26:30 -0600 Subject: [PATCH 1/3] Update readme.md --- readme.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/readme.md b/readme.md index 8e8c584..402fa31 100644 --- a/readme.md +++ b/readme.md @@ -33,21 +33,25 @@ Powered by a Flask backend and a React Flow frontend, Borealis is perfect for an ## ⚡ Getting Started -```bash -# Windows +### Windows: +```powershell +# Windows - Install Python and NodeJS Set-ExecutionPolicy Unrestricted -Scope Process; .\Prerequisites-Installer-(RunAsAdmin).ps1 -Set-ExecutionPolicy Unrestricted -Scope Process; .\Launch-Borealis.ps1 +# Windows - Launch Borealis Server and/or Agent +Set-ExecutionPolicy Unrestricted -Scope Process; .\Launch-Borealis.ps1 +``` +### Linux: +```sh # Linux / macOS bash Launch-Borealis.sh ``` -The launch script will: -- 🐍 Create a virtual Python environment -- 📦 Install all required Python + JS dependencies -- ⚛️ Build the React app -- 🌐 Launch the Flask web server - +**The launch script will**: +- :snake: Create a virtual Python environment +- :package: Install all required Python + JS dependencies +- :atom: Build the React app +- :globe_with_meridians: Launch the Flask web server --- ## 🧠 How It Works From 327b36f25e04edc79590091d10ab8085122a6f2d Mon Sep 17 00:00:00 2001 From: Nicole Rappe Date: Sun, 13 Apr 2025 20:06:09 -0600 Subject: [PATCH 2/3] Update readme.md --- readme.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/readme.md b/readme.md index 402fa31..2a0fb2b 100644 --- a/readme.md +++ b/readme.md @@ -36,12 +36,15 @@ Powered by a Flask backend and a React Flow frontend, Borealis is perfect for an ### Windows: ```powershell # Windows - Install Python and NodeJS +# You need to open a powershell window as an administrator, change the directory to Borealis's extracted ZIP, then run the command below: Set-ExecutionPolicy Unrestricted -Scope Process; .\Prerequisites-Installer-(RunAsAdmin).ps1 # Windows - Launch Borealis Server and/or Agent +# To Launch borealis itself, you can just right-click the "Launch-Borealis.ps1" file and select "Run with Powershell", or alternatively, run the command seen below, either in the same powershell session as the first command, or in its own non-administrative session. Set-ExecutionPolicy Unrestricted -Scope Process; .\Launch-Borealis.ps1 ``` ### Linux: +-# Detailed explanations of how to get things working in Linux is not given at this time, but its mostly automated during the deployment, and only requires a single script to be ran. ```sh # Linux / macOS bash Launch-Borealis.sh From 8d0d3184af471913e09f96053f046e7e0e77e414 Mon Sep 17 00:00:00 2001 From: Nicole Rappe Date: Sun, 13 Apr 2025 20:09:50 -0600 Subject: [PATCH 3/3] Update readme.md --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 2a0fb2b..1e2c522 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ -# 🌌 Borealis - Workflow Automation via Visual Node Graphs +![Borealis Logo](https://git.bunny-lab.io/Borealis/Borealis/raw/branch/main/Data/WebUI/public/Borealis_Logo_Full.png) **Borealis** is a cross-platform **visual automation platform** that lets you design and execute workflows using drag-and-drop "nodes" in an interactive graph. Think of it like building a flowchart that actually **runs** — in real-time.