{"id":13599459,"url":"https://github.com/PowerShell/Polaris","last_synced_at":"2025-04-10T12:32:53.937Z","repository":{"id":65985528,"uuid":"105558627","full_name":"PowerShell/Polaris","owner":"PowerShell","description":"A cross-platform, minimalist web framework for PowerShell","archived":true,"fork":false,"pushed_at":"2020-08-10T15:58:38.000Z","size":338,"stargazers_count":512,"open_issues_count":32,"forks_count":115,"subscribers_count":67,"default_branch":"master","last_synced_at":"2025-01-21T12:35:56.379Z","etag":null,"topics":["framework","hacktoberfest","powershell","webserver"],"latest_commit_sha":null,"homepage":"https://powershell.github.io/Polaris/","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PowerShell.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-02T16:39:44.000Z","updated_at":"2025-01-07T15:06:58.000Z","dependencies_parsed_at":"2023-02-19T19:15:42.523Z","dependency_job_id":null,"html_url":"https://github.com/PowerShell/Polaris","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PowerShell%2FPolaris","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PowerShell%2FPolaris/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PowerShell%2FPolaris/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PowerShell%2FPolaris/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PowerShell","download_url":"https://codeload.github.com/PowerShell/Polaris/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248217145,"owners_count":21066633,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["framework","hacktoberfest","powershell","webserver"],"created_at":"2024-08-01T17:01:04.480Z","updated_at":"2025-04-10T12:32:53.207Z","avatar_url":"https://github.com/PowerShell.png","language":"PowerShell","readme":"# Polaris\n\n[![Join the chat at https://gitter.im/PowerShell/Polaris](https://badges.gitter.im/PowerShell/Polaris.svg)](https://gitter.im/PowerShell/Polaris?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n[![Build Status](https://powershell.visualstudio.com/Polaris/_apis/build/status/PowerShell.Polaris?branchName=master)](https://powershell.visualstudio.com/Polaris/_build/latest?definitionId=73\u0026branchName=master)\n[![PowerShell Gallery](https://img.shields.io/powershellgallery/v/polaris.svg)](https://www.powershellgallery.com/packages/Polaris)\n\nA cross-platform, minimalist web framework for [PowerShell](https://github.com/powershell/powershell).\n\n## Disclaimer\n\nPolaris is currently an **unsupported, experimental, proof-of-concept**. There is no current plan to turn it into a supported Microsoft product.\n\nThat being said, we do plan on continuing to experiment within this repository for the foreseeable future.\n\n## Example\n\n```PowerShell\nNew-PolarisGetRoute -Path \"/helloworld\" -Scriptblock {\n    $Response.Send('Hello World!')\n}\n\nStart-Polaris\n```\n\n### Why yet another web framework for PowerShell?\n\nThere 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!).\n\nPolaris' 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.\n\n## Getting Started\n\n### Prerequisites\n\n- [PowerShell](https://github.com/powershell/powershell)\n\n### Steps\n\n#### From the [PowerShell Gallery](https://powershellgallery.com)\n\n```powershell\nPS \u003e Install-Module -Name Polaris -Scope CurrentUser -Force\n```\n\nYou can now try out the [example above](#example) or checkout [the site](https://PowerShell.github.io/Polaris) for more usage information!\n\n#### From source\n\n1. Clone or download the zip of the repo\n1. Open [PowerShell](https://github.com/powershell/powershell)\n1. At this point, you can now run `Import-Module ./Polaris.psd1`\n\nYou can now try out the [example above](#example) or checkout [the site](https://PowerShell.github.io/Polaris) for more usage!\n\nYou 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.\n\n## Documentation\n\nCheck 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.\n\n## Troubleshooting / Questions\n\n- **Twitter:** #PSPolaris\n- **Slack:** See us in the #Polaris channel of the [PowerShell Slack](http://slack.poshcode.org/)\n- **GitHub Issues:** Submit a bug / new feature idea / or just a question as a new GitHub issue\n\n## Roadmap\n\nWe have a few paths we are interested in taking. We hope the community helps direct us.\n\n- 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)\n- Investigating the use of [Kestrel](https://github.com/aspnet/KestrelHttpServer)/[ASP.NET Routing](https://github.com/aspnet/routing) instead of HttpListener\n- Creating a routing domain-specific language (DSL) for isolating and running script blocks as routes. Drawing inspiration from [Pester](https://github.com/pester/Pester/).\n\n## Feedback\n\nThis project is an experiment that has the possibility to grow into something great.\nWe can't do that without great feedback from you.\n\nIf you have an idea or find a bug, join the discussions in the issues or create a new issue.\n\n## License\n\nPolaris is licensed under the MIT License.\n\n## Maintainers\n\n- [Tyler Leonhardt](https://github.com/tylerl0706) - [@TylerLeonhardt](https://twitter.com/TylerLeonhardt)\n- [Micah Rairdon](https://github.com/tiberriver256) - [@tiberriver256](https://twitter.com/tiberriver256)\n\n## Code of Conduct\n\nThis project has adopted the [Microsoft Open Source Code of Conduct][conduct-code].\nFor more information see the [Code of Conduct FAQ][conduct-faq] or contact [opencode@microsoft.com][conduct-email] with any additional questions or comments.\n\n[conduct-code]: http://opensource.microsoft.com/codeofconduct/\n[conduct-faq]: http://opensource.microsoft.com/codeofconduct/faq/\n[conduct-email]: mailto:opencode@microsoft.com\n","funding_links":[],"categories":["PowerShell","Webserver"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPowerShell%2FPolaris","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPowerShell%2FPolaris","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPowerShell%2FPolaris/lists"}