Pode.Web

This is the develop branch for Pode.Web v1.0.0, which is currently dependant on Pode v2.10.1. If you want the latest released Pode.Web code (v0.8.3), please view the master branch instead.

💝 A lot of my free time, evenings, and weekends goes into making Pode happen; please do consider sponsoring as it will really help! 😊

• 📦 Libraries
• 📘 Documentation
• 🚀 Features
• 📦 Install
• 🙌 Contributing
• 🔥 Quick Example
• 🌎 Roadmap

This is a web template framework for use with the Pode PowerShell web server (v2.10.1+).

It allows you to build web pages purely with PowerShell - no HTML, CSS, or JavaScript knowledge is required!

You can build charts, forms, tables, general text, tabs, login pages, etc. There's a light, dark, terminal, and more themes available, and you can supply custom CSS files or build your own in PowerShell.

📦 Libraries

The Pode.Web templates are built using Bootstrap, jQuery, Material Design Icons, Chart.js, and Highlight.js.

📘 Documentation

All documentation and tutorials for Pode.Web can be found here - this documentation will be for the latest release.

To see the docs for other releases, branches, or tags, you can host the documentation locally. To do so you'll need to have the InvokeBuild module installed; then:

Invoke-Build Docs

Then navigate to http://127.0.0.1:8000 in your browser.

🚀 Features

• Like Pode, this is already cross-platform! (with support for PS5)
• Easily add pages, with different elements
• Support for authentication with a login page!
• Create line, bar, pie, and doughnut charts
• Support for forms, with all kinds of input elements
• Show toast messages on the page, or send desktop notifications
• Display data in tables, with pagination, sorting, and filtering
• Use a stepper for a more controlled flow of form input
• Or, use a tabs layout for your pages!
• Show or right code via the Monaco editor (still WIP)
• Render code in code blocks with code highlighting!
• Support for Light, Dark, Terminal, custom themes, and more

📦 Install

You can install Pode.Web from the PowerShell Gallery, or via Docker:

# powershell gallery
Install-Module -Name Pode.Web

# docker
docker pull badgerati/pode.web

🙌 Contributing

Pull Requests, Bug Reports and Feature Requests are welcome! Feel free to help out with Issues and Projects!

To build Pode.Web, before running any examples, run the following:

Invoke-Build Build

To work on issues you can fork Pode.Web, and then open a Pull Request for approval. Pull Requests should be made against the develop branch. Each Pull Request should also have an appropriate issue created.

🔥 Quick Example

The below will build a web page that shows a chart with the top 10 processes running on your machine, and that auto-refreshes every minute:

Import-Module Pode.Web

Start-PodeServer {
    # add a simple endpoint
    Add-PodeEndpoint -Address localhost -Port 8090 -Protocol Http

    # set the use of the pode.web templates
    Use-PodeWebTemplates -Title 'Example' -Theme Midnight

    # add the page
    Add-PodeWebPage -Name Processes -Icon Activity -ScriptBlock {
        New-PodeWebChart -Name 'Top Processes' -Type Bar -AutoRefresh -AsCard -ScriptBlock {
            Get-Process |
                Sort-Object -Property CPU -Descending |
                Select-Object -First 10 |
                ConvertTo-PodeWebChartData -LabelProperty ProcessName -DatasetProperty CPU
        }
    }
}

🌎 Roadmap

You can find a list of the features, enhancements, and ideas that will hopefully one day make it into Pode.Web here in the documentation.

There is also a Project in the beginning of being set up for Pode.Web, with milestone progression and current roadmap issues. Plus, there is a Draft Board that contains a range of ideas for Pode.Web features/enhancements that are either brilliant, ludicrous, or downright insane! Draft Issues are purely ideas, and any in the design stage might one day make it in! If you see a Draft Issue you wish to discuss or have an idea for one, please discuss it over on Discord in the #ideas or #pode-web channel.