Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/powershell/polaris

A cross-platform, minimalist web framework for PowerShell
https://github.com/powershell/polaris

framework hacktoberfest powershell webserver

Last synced: 6 days ago
JSON representation

A cross-platform, minimalist web framework for PowerShell

Host: GitHub
URL: https://github.com/powershell/polaris
Owner: PowerShell
License: mit
Archived: true
Created: 2017-10-02T16:39:44.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2020-08-10T15:58:38.000Z (about 4 years ago)
Last Synced: 2024-09-27T21:06:03.365Z (6 days ago)
Topics: framework, hacktoberfest, powershell, webserver
Language: PowerShell
Homepage: https://powershell.github.io/Polaris/
Size: 330 KB
Stars: 508
Watchers: 67
Forks: 113
Open Issues: 32
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        # Polaris

[![Join the chat at https://gitter.im/PowerShell/Polaris](https://badges.gitter.im/PowerShell/Polaris.svg)](https://gitter.im/PowerShell/Polaris?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Build Status](https://powershell.visualstudio.com/Polaris/_apis/build/status/PowerShell.Polaris?branchName=master)](https://powershell.visualstudio.com/Polaris/_build/latest?definitionId=73&branchName=master)

[![PowerShell Gallery](https://img.shields.io/powershellgallery/v/polaris.svg)](https://www.powershellgallery.com/packages/Polaris)

A cross-platform, minimalist web framework for [PowerShell](https://github.com/powershell/powershell).

## Disclaimer

Polaris is currently an **unsupported, experimental, proof-of-concept**. There is no current plan to turn it into a supported Microsoft product.

That being said, we do plan on continuing to experiment within this repository for the foreseeable future.

## Example

```PowerShell

New-PolarisGetRoute -Path "/helloworld" -Scriptblock {

    $Response.Send('Hello World!')

}

Start-Polaris

```

### Why yet another web framework for PowerShell?

There have been a great list of [other](https://github.com/StartAutomating/Pipeworks) [micro](https://github.com/toenuff/flancy) [web](https://github.com/Jaykul/NancyPS/) [frameworks](https://github.com/toenuff/PshOdata) [written](https://github.com/straightdave/presley) [over](https://github.com/cofonseca/WebListener) [the](https://github.com/DataBooster/PS-WebApi) [years](https://github.com/ChristopherGLewis/PowerShellWebServers) (Thanks @jaykul for the list!).

Polaris' differentiation is that it is cross-platform and uses the .NET [HttpListener](https://docs.microsoft.com/en-us/dotnet/api/system.net.httplistener?view=netcore-3.1) class.

## Getting Started

### Prerequisites

- [PowerShell](https://github.com/powershell/powershell)

### Steps

#### From the [PowerShell Gallery](https://powershellgallery.com)

```powershell

PS > Install-Module -Name Polaris -Scope CurrentUser -Force

```

You can now try out the [example above](#example) or checkout [the site](https://PowerShell.github.io/Polaris) for more usage information!

#### From source

1. Clone or download the zip of the repo

1. Open [PowerShell](https://github.com/powershell/powershell)

1. At this point, you can now run `Import-Module ./Polaris.psd1`

You can now try out the [example above](#example) or checkout [the site](https://PowerShell.github.io/Polaris) for more usage!

You can also run all the Pester tests by running `Invoke-Pester` in the `test` directory. You will need [Pester](https://github.com/pester/Pester) version [4.1.0](https://github.com/pester/Pester/blob/master/CHANGELOG.md#410-november-15-2017) or higher to run the tests on Linux or MacOS.

## Documentation

Check out the [docs folder](https://github.com/PowerShell/Polaris/tree/master/docs) or [the site](https://PowerShell.github.io/Polaris) for a full API reference.

## Troubleshooting / Questions

- **Twitter:** #PSPolaris

- **Slack:** See us in the #Polaris channel of the [PowerShell Slack](http://slack.poshcode.org/)

- **GitHub Issues:** Submit a bug / new feature idea / or just a question as a new GitHub issue

## Roadmap

We have a few paths we are interested in taking. We hope the community helps direct us.

- Expanding on the current implementation using HttpListener to deliver features you'd expect from projects ASP.NET or Expressjs (route parameters, query parameters, middleware, auth etc)

- Investigating the use of [Kestrel](https://github.com/aspnet/KestrelHttpServer)/[ASP.NET Routing](https://github.com/aspnet/routing) instead of HttpListener

- Creating a routing domain-specific language (DSL) for isolating and running script blocks as routes. Drawing inspiration from [Pester](https://github.com/pester/Pester/).

## Feedback

This project is an experiment that has the possibility to grow into something great.

We can't do that without great feedback from you.

If you have an idea or find a bug, join the discussions in the issues or create a new issue.

## License

Polaris is licensed under the MIT License.

## Maintainers

- [Tyler Leonhardt](https://github.com/tylerl0706) - [@TylerLeonhardt](https://twitter.com/TylerLeonhardt)

- [Micah Rairdon](https://github.com/tiberriver256) - [@tiberriver256](https://twitter.com/tiberriver256)

## Code of Conduct

This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code].

For more information see the [Code of Conduct FAQ][conduct-faq] or contact [[email protected]][conduct-email] with any additional questions or comments.

[conduct-code]: http://opensource.microsoft.com/codeofconduct/

[conduct-faq]: http://opensource.microsoft.com/codeofconduct/faq/

[conduct-email]: mailto:[email protected]