|
| 1 | +<div id="top" align="center"> |
| 2 | + |
| 3 | +<!-- Shields Header --> |
| 4 | +[![Contributors][contributors-shield]](https://github.com/franckferman/PowerShell-Script-GUI-Template/graphs/contributors) |
| 5 | +[![Forks][forks-shield]](https://github.com/franckferman/PowerShell-Script-GUI-Template/network/members) |
| 6 | +[![Stargazers][stars-shield]](https://github.com/franckferman/PowerShell-Script-GUI-Template/stargazers) |
| 7 | +[![License][license-shield]](https://github.com/franckferman/PowerShell-Script-GUI-Template/blob/stable/LICENSE) |
| 8 | + |
| 9 | +<!-- Logo --> |
| 10 | +<a href="https://github.com/franckferman/PowerShell-Script-GUI-Template"> |
| 11 | + <img src="https://raw.githubusercontent.com/franckferman/PowerShell-Script-GUI-Template/refs/heads/stable/docs/github/graphical_resources/Logo-without_background-PowerShell-Script-GUI-Template.png" alt="PowerShell-Script-GUI-Template Logo" width="auto" height="auto"> |
| 12 | +</a> |
| 13 | + |
| 14 | +<!-- Title & Tagline --> |
| 15 | +<h3 align="center">🔹 PowerShell GUI Script Template</h3> |
| 16 | +<p align="center"> |
| 17 | + <em>Build interactive Windows GUI apps using only PowerShell.</em> |
| 18 | + <br> |
| 19 | + Create admin tools, automation panels, and user interfaces without writing C#/WPF — all in native PowerShell. |
| 20 | +</p> |
| 21 | + |
| 22 | +</div> |
| 23 | + |
| 24 | +## 📜 Table of Contents |
| 25 | + |
| 26 | +<details open> |
| 27 | + <summary><strong>Click to collapse/expand</strong></summary> |
| 28 | + <ol> |
| 29 | + <li><a href="#-about">📖 About</a></li> |
| 30 | + <li><a href="#-installation">🛠️ Installation</a></li> |
| 31 | + <li><a href="#-usage">🎮 Usage</a></li> |
| 32 | + <li><a href="#-star-evolution">🌠 Star Evolution</a></li> |
| 33 | + <li><a href="#-license">📜 License</a></li> |
| 34 | + <li><a href="#-contact">📞 Contact</a></li> |
| 35 | + </ol> |
| 36 | +</details> |
| 37 | + |
| 38 | +## 📖 About |
| 39 | + |
| 40 | +**PowerShell GUI Script Template** is a **fully modular and ready-to-use template** for building interactive PowerShell GUI applications tailored for **Windows administration, automation, and user interaction**. |
| 41 | + |
| 42 | +Originally built for **personal and professional automation needs**, this template is now shared to help others **quickly bootstrap** robust PowerShell GUI projects. It enables system administrators, IT professionals, and developers to **create user-friendly interfaces** that interactively handle data, automate processes, and manage systems — without needing C#/VB.NET. |
| 43 | + |
| 44 | +> ⚙️ **Note**: Focused on being **clean, efficient, and extensible**, providing ready-to-use blocks for forms, buttons, dialogs, and admin actions. |
| 45 | + |
| 46 | +<p align="center"> |
| 47 | + <img src="https://raw.githubusercontent.com/franckferman/PowerShell-Script-GUI-Template/refs/heads/stable/docs/github/graphical_resources/PowerShell-Script-GUI-Template-main.png" alt="PowerShell Script GUI Template main menu Demo Screenshot" width="auto" height="auto"> |
| 48 | +</p> |
| 49 | + |
| 50 | +<p align="right">(<a href="#top">🔼 Back to top</a>)</p> |
| 51 | + |
| 52 | +## 🚀 Installation |
| 53 | + |
| 54 | +### Prerequisites |
| 55 | + |
| 56 | +- **Windows OS** (Tested on **Windows 10 & 11** — may work on older versions but not officially supported). |
| 57 | +- **PowerShell 5.1 or higher** (pre-installed on modern Windows). |
| 58 | + |
| 59 | +> ⚠️ **Note**: 100% **pure PowerShell**, **no external software required**. |
| 60 | + |
| 61 | +### Getting the Template |
| 62 | + |
| 63 | +#### Option 1: Clone via Git (Recommended) |
| 64 | +```powershell |
| 65 | +git clone https://github.com/franckferman/PowerShell-Script-GUI-Template.git |
| 66 | +``` |
| 67 | + |
| 68 | +#### Option 2: **Direct Download** from GitHub |
| 69 | +1. Go to GitHub repo. |
| 70 | +2. Click `<> Code` → `Download ZIP`. |
| 71 | +3. Extract the archive to your desired location. |
| 72 | + |
| 73 | +Both methods will provide you with the complete set of files required to use the `PowerShell-Script-GUI-Template`. |
| 74 | + |
| 75 | +<p align="right">(<a href="#top">🔼 Back to top</a>)</p> |
| 76 | + |
| 77 | +## 🎮 Usage |
| 78 | + |
| 79 | +### Getting started |
| 80 | + |
| 81 | +1. Open PowerShell as Administrator. |
| 82 | +2. Temporarily allow script execution: |
| 83 | +```powershell |
| 84 | +Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope Process |
| 85 | +``` |
| 86 | + |
| 87 | +> 🛑 Important: This command temporarily adjusts the execution policy to allow script execution for the current process only, minimizing security risks. |
| 88 | +> Always examine scripts before executing them to ensure safety. |
| 89 | + |
| 90 | +3. Run the GUI script: |
| 91 | +```powershell |
| 92 | +.\PowerShellScriptGUITemplate.ps1 |
| 93 | +``` |
| 94 | + |
| 95 | +Alternatively, for a streamlined approach, combine the execution policy adjustment with script launch in a single line: |
| 96 | +```powershell |
| 97 | +Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope Process; .\PowerShellScriptGUITemplate.ps1 |
| 98 | +``` |
| 99 | + |
| 100 | +> This command executes the main script, bringing up the GUI for interactive use. |
| 101 | +> The template provides a user-friendly graphical interface, facilitating navigation through various automation tasks and options with ease. |
| 102 | + |
| 103 | +<p align="right">(<a href="#top">🔼 Back to top</a>)</p> |
| 104 | + |
| 105 | +## 🌠 Star Evolution |
| 106 | + |
| 107 | +Explore the star history of this project and see how it has evolved over time: |
| 108 | + |
| 109 | +<a href="https://star-history.com/#franckferman/MetaDetective&Timeline"> |
| 110 | + <picture> |
| 111 | + <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=franckferman/PowerShell-Script-GUI-Template&type=Timeline&theme=dark" /> |
| 112 | + <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=franckferman/PowerShell-Script-GUI-Template&type=Timeline" /> |
| 113 | + </picture> |
| 114 | +</a> |
| 115 | + |
| 116 | +Your support is greatly appreciated. We're grateful for every star! Your backing fuels our passion. ✨ |
| 117 | + |
| 118 | +## 📚 License |
| 119 | + |
| 120 | +This project is licensed under the GNU Affero General Public License, Version 3.0. For more details, please refer to the LICENSE file in the repository: [Read the license on GitHub](https://github.com/franckferman/PowerShell-Script-GUI-Template/blob/stable/LICENSE) |
| 121 | + |
| 122 | +<p align="right">(<a href="#top">🔼 Back to top</a>)</p> |
| 123 | + |
| 124 | +## 📞 Contact |
| 125 | + |
| 126 | +[![ProtonMail][protonmail-shield]](mailto:contact@franckferman.fr) |
| 127 | +[![LinkedIn][linkedin-shield]](https://www.linkedin.com/in/franckferman) |
| 128 | +[![Twitter][twitter-shield]](https://www.twitter.com/franckferman) |
| 129 | + |
| 130 | +<p align="right">(<a href="#top">🔼 Back to top</a>)</p> |
| 131 | + |
| 132 | +<!-- MARKDOWN LINKS & IMAGES --> |
| 133 | +<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> |
| 134 | +[contributors-shield]: https://img.shields.io/github/contributors/franckferman/PowerShell-Script-GUI-Template.svg?style=for-the-badge |
| 135 | +[contributors-url]: https://github.com/franckferman/PowerShell-Script-GUI-Template/graphs/contributors |
| 136 | +[forks-shield]: https://img.shields.io/github/forks/franckferman/PowerShell-Script-GUI-Template.svg?style=for-the-badge |
| 137 | +[forks-url]: https://github.com/franckferman/PowerShell-Script-GUI-Template/network/members |
| 138 | +[stars-shield]: https://img.shields.io/github/stars/franckferman/PowerShell-Script-GUI-Template.svg?style=for-the-badge |
| 139 | +[stars-url]: https://github.com/franckferman/PowerShell-Script-GUI-Template/stargazers |
| 140 | +[license-shield]: https://img.shields.io/github/license/franckferman/PowerShell-Script-GUI-Template.svg?style=for-the-badge |
| 141 | +[license-url]: https://github.com/franckferman/PowerShell-Script-GUI-Template/blob/stable/LICENSE |
| 142 | +[protonmail-shield]: https://img.shields.io/badge/ProtonMail-8B89CC?style=for-the-badge&logo=protonmail&logoColor=blueviolet |
| 143 | +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=blue |
| 144 | +[twitter-shield]: https://img.shields.io/badge/-Twitter-black.svg?style=for-the-badge&logo=twitter&colorB=blue |
| 145 | + |
0 commit comments