|
1 | | -# .NET nanoFramework WebServer |
| 1 | +[](https://sonarcloud.io/dashboard?id=nanoframework_lib-nanoframework.WebServer) [](https://sonarcloud.io/dashboard?id=nanoframework_lib-nanoframework.WebServer) [](LICENSE) [](https://www.nuget.org/packages/nanoFramework.WebServer/) [](https://github.com/nanoframework/Home/blob/main/CONTRIBUTING.md) [](https://discord.gg/gCyBu8T) |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | +----- |
| 6 | + |
| 7 | +### Welcome to the .NET **nanoFramework** WebServer repository |
| 8 | + |
| 9 | +## Build status |
| 10 | + |
| 11 | +| Component | Build Status | NuGet Package | |
| 12 | +|:-|---|---| |
| 13 | +| nanoFramework.WebServer | [](https://dev.azure.com/nanoframework/nanoFramework.WebServer/_build/latest?definitionId=65&branchName=main) | [](https://www.nuget.org/packages/nanoFramework.WebServer/) | |
| 14 | +| nanoFramework.WebServer (preview) | [](https://dev.azure.com/nanoframework/nanoFramework.WebServer/_build/latest?definitionId=65&repoName=nanoframework%2FnanoFramework.WebServer&branchName=develop) | [](https://www.nuget.org/packages/nanoFramework.WebServer/) | |
| 15 | + |
| 16 | +## .NET nanoFramework WebServer |
| 17 | + |
| 18 | +This library was coded by [Laurent Ellerbach](@Ellerbach) who generously offered it to the .NET **nanoFramework** project. |
2 | 19 |
|
3 | 20 | This is a simple nanoFramework WebServer. Features: |
4 | 21 |
|
5 | | -- Handle multithread requests |
| 22 | +- Handle multi-thread requests |
6 | 23 | - Serve static files on any storage |
7 | 24 | - Handle parameter in URL |
8 | 25 | - Possible to have multiple WebServer running at the same time |
@@ -83,7 +100,7 @@ There is a more advance example with simple REST API to get a list of Person and |
83 | 100 |
|
84 | 101 | ## A simple GPIO controller REST API |
85 | 102 |
|
86 | | -You will find in simple [GPIO controller sample](./WebServer.GpioRest) REST API. The controller not case sensitive and is working like this: |
| 103 | +You will find in simple [GPIO controller sample](https://github.com/nanoframework/Samples/tree/main/samples/Webserver/WebServer.GpioRest) REST API. The controller not case sensitive and is working like this: |
87 | 104 |
|
88 | 105 | - To open the pin 2 as output: http://yoururl/open/2/output |
89 | 106 | - To open pin 4 as input: http://yoururl/open/4/input |
@@ -350,3 +367,26 @@ using (WebServer server = new WebServer(443, HttpProtocol.Https) |
350 | 367 | > IMPORTANT: because the certificate above is not issued from a Certificate Authority it won't be recognized as a valid certificate. If you want to access the nanoFramework device with your browser, for example, you'll have to add the (CRT file)[WebServer.Sample\webserver-cert.crt] as a trusted one. On Windows, you just have to double click on the CRT file and then click "Install Certificate...". |
351 | 368 |
|
352 | 369 | You can of course use the routes as defined earlier. Both will work, event or route with the notion of controller. |
| 370 | + |
| 371 | +## Feedback and documentation |
| 372 | + |
| 373 | +For documentation, providing feedback, issues and finding out how to contribute please refer to the [Home repo](https://github.com/nanoframework/Home). |
| 374 | +
|
| 375 | +Join our Discord community [here](https://discord.gg/gCyBu8T). |
| 376 | +
|
| 377 | +## Credits |
| 378 | + |
| 379 | +The list of contributors to this project can be found at [CONTRIBUTORS](https://github.com/nanoframework/Home/blob/main/CONTRIBUTORS.md). |
| 380 | +
|
| 381 | +## License |
| 382 | + |
| 383 | +The **nanoFramework** WebServer library is licensed under the [MIT license](LICENSE.md). |
| 384 | + |
| 385 | +## Code of Conduct |
| 386 | + |
| 387 | +This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behaviour in our community. |
| 388 | +For more information see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct). |
| 389 | +
|
| 390 | +### .NET Foundation |
| 391 | + |
| 392 | +This project is supported by the [.NET Foundation](https://dotnetfoundation.org). |
0 commit comments