You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-`Routing.map[Get|Head|Post|Put|Patch|Delete|Options|Trace|Any]` which produces `HttpEndpoint` by associating a route pattern to an `HttpHandler` after mapping route.
19
+
-`Routing.setDisplayName` to set the display name of the endpoint.
20
+
-`Routing.setOrder` to set the order number of the endpoint.
21
+
-`WebApplication.run`, registers the provided `HttpHandler` as the terminal middleware and runs the application.
22
+
23
+
### Changed
24
+
25
+
-`Xss` module renamed to `Xsrf`. Functions: `Xsrf.antiforgeryInput`, `Xsrf.getToken` & `Xsrf.validateToken`.
26
+
27
+
28
+
### Fixed
29
+
30
+
- Missing cancellation token pass-through during form reading, `multipart/form-data` streaming and JSON serialization/deserialization.
31
+
- Empty request body support for JSON request methods.
32
+
-`WebApplication.UseFalcoNotFound` & `IApplicationBuilder.UseFalcoNotFound` to correctly terminate by returning `unit` akin to the native method.
33
+
34
+
### Removed
35
+
36
+
-`net6.0` support dropped (end of life 2024-11-12).
-`StringCollectionReader` and derivatives removed (`FormCollectionReader`, `QueryCollectionReader`, `RouteCollectionReader`, `HeaderCollectionReader`, and `CookieCollectionReader`).
44
+
- All replaced by homogenous `RequestData` type.
45
+
-`Request.streamForm`, `Request.streamFormSecure`, `Request.mapFormStream` and `Request.mapFormStreamSecure` removed.
46
+
-`Falco.Security.Crypto` and `Falco.Security.Auth` modules removed.
Copy file name to clipboardexpand all lines: README.md
+27-34
Original file line number
Diff line number
Diff line change
@@ -5,55 +5,49 @@
5
5
6
6
```fsharp
7
7
open Falco
8
-
open Falco.Routing
9
-
open Falco.HostBuilder
10
-
11
-
webHost [||] {
12
-
endpoints [
13
-
get "/" (Response.ofPlainText "Hello World")
14
-
]
15
-
}
8
+
open Microsoft.AspNetCore.Builder
9
+
10
+
let wapp = WebApplication.Create()
11
+
12
+
wapp.Run(Response.ofPlainText "Hello world")
16
13
```
17
14
18
-
[Falco](https://github.com/pimbrouwers/Falco) is a toolkit for building fast and functional-first web applications using F#.
15
+
[Falco](https://github.com/pimbrouwers/Falco) is a toolkit for building fast and functional-first web applications using F#. You can think of it as [minimal API](https://learn.microsoft.com/en-us/aspnet/core/tutorials/min-web-api?view=aspnetcore-8.0&tabs=visual-studio) on *steroids*.
19
16
20
-
-Built upon the high-performance components of ASP.NET Core.
21
-
-Optimized for building HTTP applications quickly.
17
+
-Designed for building pure F# full-stack web applications.
18
+
-Built on the high-performance components of ASP.NET Core.
22
19
- Seamlessly integrates with existing .NET Core middleware and libraries.
-Uniform API for [accessing request data](https://github.com/pimbrouwers/Falco/tree/master/documentation/request.md).
31
-
-[Authentication and security](https://github.com/pimbrouwers/Falco/tree/master/documentation/security.md) utilities.
32
-
- Built-in support for [large uploads](https://github.com/pimbrouwers/Falco/tree/master/documentation/request.md#multipartform-data-binding) and [binary responses](https://github.com/pimbrouwers/Falco/tree/master/documentation/response.md#content-disposition).
23
+
-Simple and powerful [routing](documentation/routing.md) API.
24
+
-Uniform API for [accessing _any_ request data](documentation/request.md).
-[Authentication](documentation/authentication.md) and [security](documentation/cross-site-request-forgery.md) utilities.
28
+
-Built-in support for [large uploads](documentation/request.md#multipartform-data-binding) and [binary responses](documentation/response.md#content-disposition).
29
+
33
30
34
31
## Design Goals
35
32
36
-
- Provide a toolset to build a working full-stack web application.
33
+
- Provide a toolset to build full-stack web application in F#.
37
34
- Should be simple, extensible and integrate with existing .NET libraries.
38
35
- Can be easily learned.
39
36
40
-
## Learn
41
37
42
-
The best way to get started is by visiting the [documentation](https://falcoframework.com/docs). For questions and support please use [discussions](https://github.com/pimbrouwers/Falco/discussions). The issue list of this repo is **exclusively** for bug reports and feature requests. For chronological updates refer to the [changelog](CHANGELOG.md) is the best place to find chronological updates.
43
-
44
-
If you want to stay in touch, feel free to reach out on [Twitter](https://twitter.com/falco_framework).
38
+
## Learn
45
39
46
-
Have an article or video that you want to share? We'd love to hear from you! To add your content, visit this [discussion](https://github.com/pimbrouwers/Falco/discussions/82).
40
+
The best way to get started is by visiting the [documentation](https://falcoframework.com/docs). For questions and support please use [discussions](https://github.com/pimbrouwers/Falco/discussions). For chronological updates refer to the [changelog](CHANGELOG.md) is the best place to find chronological updates.
47
41
48
42
### Related Libraries
49
43
50
44
-[Falco.Markup](https://github.com/pimbrouwers/Falco.Markup) - an XML markup module primary used as the syntax for [authoring HTML with Falco](https://www.falcoframework.com/docs/markup.html).
45
+
-[Falco.Htmx](https://github.com/dpraimeyuu/Falco.Htmx) - a full featured integration with [htmx JS package](https://htmx.org/).
46
+
-[Falco.OpenApi](https://github.com/pimbrouwers/Falco.OpenApi) - a library for generating OpenAPI documentation from Falco applications.
51
47
-[Falco.Template](https://github.com/pimbrouwers/Falco.Template) - a .NET SDK [project template](https://learn.microsoft.com/en-us/dotnet/core/tools/custom-templates) to help get started with Falco quickly.
52
-
-[Falco.Htmx](https://github.com/dpraimeyuu/Falco.Htmx) - An experimental Falco integration with [htmx JS package](https://htmx.org/).
53
48
54
49
### Community Projects
55
50
56
-
-[FalcoJournal](https://github.com/pimbrouwers/FalcoJournal) - A bullet journal built with Falco, .NET 5.x and ASP.NET Core.
57
51
-[Falco GraphQL Sample](https://github.com/adelarsq/falco_graphql_sample) - A sample showing how to use GraphQL on Falco using .NET 6.
58
52
-[Falco API with Tests Sample](https://github.com/jasiozet/falco-api-with-tests-template) - A sample project using Falco and unit testing.
59
53
-[Falco + SQLite + Donald](https://github.com/galassie/FalcoSample) - A demo project using Falco, [Donald](https://github.com/pimbrouwers/Donald), and SQLite
@@ -67,29 +61,28 @@ Have an article or video that you want to share? We'd love to hear from you! To
67
61
68
62
- Ben Gobeil - [Why I'm Using Falco Instead Of Saturn | How To Switch Your Backend In SAFE Stack | StonkWatch Ep.13](https://youtu.be/DTy5gIUWvpo)
69
63
70
-
## Contribute
71
64
72
-
Thank you for considering contributing to Falco, and to those who have already contributed! We appreciate (and actively resolve) PRs of all shapes and sizes.
65
+
## Contribute
73
66
74
67
We kindly ask that before submitting a pull request, you first submit an [issue](https://github.com/pimbrouwers/Falco/issues) or open a [discussion](https://github.com/pimbrouwers/Falco/discussions).
75
68
69
+
If functionality is added to the API, or changed, please kindly update the relevant [document](docs). Unit tests must also be added and/or updated before a pull request can be successfully merged.
76
70
77
-
If functionality is added to the API, or changed, please kindly update the relevant [document](https://github.com/pimbrouwers/Falco/tree/master/docs). Unit tests must also be added and/or updated before a pull request can be successfully merged.
78
-
79
-
All pull requests should originate from the `develop` branch. A merge into this branch means that your changes are scheduled to go into production with the very next release, which could happen any time from the same day up to a couple weeks (depending on priorities and urgency).
80
-
81
-
Only pull requests which pass all build checks and comply with the general coding guidelines can be approved.
71
+
Only pull requests which pass all build checks and comply with the general coding standard can be approved.
82
72
83
73
If you have any further questions, submit an [issue](https://github.com/pimbrouwers/Falco/issues) or open a [discussion](https://github.com/pimbrouwers/Falco/discussions) or reach out on [Twitter](https://twitter.com/falco_framework).
84
74
75
+
85
76
## Why "Falco"?
86
77
87
78
[Kestrel](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel) has been a game changer for the .NET web stack. In the animal kingdom, "Kestrel" is a name given to several members of the falcon genus. Also known as "Falco".
88
79
80
+
89
81
## Find a bug?
90
82
91
83
There's an [issue](https://github.com/pimbrouwers/Falco/issues) for that.
92
84
85
+
93
86
## License
94
87
95
-
Built with ♥ by [Pim Brouwers](https://github.com/pimbrouwers) in Toronto, ON. Licensed under [Apache License 2.0](https://github.com/pimbrouwers/Falco/blob/master/LICENSE).
88
+
Licensed under [Apache License 2.0](https://github.com/pimbrouwers/Falco/blob/master/LICENSE).
0 commit comments