pnise / pode Goto Github PK

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

• 📘 Documentation
• 🚀 Features
• 📦 Install
• 🙌 Contributing
• 🌎 Roadmap

Pode is a Cross-Platform framework for creating web servers to host REST APIs, Web Pages, and SMTP/TCP Servers. Pode also allows you to render dynamic files using .pode files, which are just embedded PowerShell, or other Third-Party template engines. Plus many more features, including Azure Functions and AWS Lambda support!

See here for building your first app! Don't know HTML, CSS, or JavaScript? No problem! Pode.Web is currently a work in progress, and lets you build web pages using purely PowerShell!

All documentation and tutorials for Pode 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.

• Cross-platform using PowerShell Core (with support for PS5)
• Docker support, including images for ARM/Raspberry Pi
• Azure Functions, AWS Lambda, and IIS support
• OpenAPI, Swagger, and ReDoc support
• Listen on a single or multiple IP address/hostnames
• Cross-platform support for HTTP(S), SMTP(S), and TCP(S)
• Cross-platform support for WebSockets, including secure WebSockets
• Host REST APIs, Web Pages, and Static Content (with caching)
• Support for custom error pages
• Request and Response compression using GZip/Deflate
• Multi-thread support for incoming requests
• Inbuilt template engine, with support for third-parties
• Async timers for short-running repeatable processes
• Async scheduled tasks using cron expressions for short/long-running processes
• Supports logging to CLI, Files, and custom logic for other services like LogStash
• Cross-state variable access across multiple runspaces
• Restart the server via file monitoring, or defined periods/times
• Ability to allow/deny requests from certain IP addresses and subnets
• Basic rate limiting for IP addresses and subnets
• Middleware and Sessions on web servers, with Flash message and CSRF support
• Authentication on requests, such as Basic, Windows and Azure AD
• Support for dynamically building Routes from Functions and Modules
• Generate/bind self-signed certificates
• (Windows) Open the hosted server as a desktop application

You can install Pode from either Chocolatey, the PowerShell Gallery, or Docker:

# chocolatey
choco install pode

# powershell gallery
Install-Module -Name Pode

# docker
docker pull badgerati/pode

The full contributing guide can be found here

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

To run the unit tests, run the following command from the root of the repository (this will build Pode and, if needed, auto-install Pester/.NET):

Invoke-Build Test

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

Invoke-Build Build

To work on issues you can fork Pode, 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.

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

There is also a Project Board in the beginnings of being setup for Pode, with milestone progression and current roadmap issues and ideas. If you see any draft issues you wish to discuss, or have an idea for one, please dicuss it over on Discord in the #ideas or #pode channel.