docs/index.html

<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8" /><meta http-equiv="X-UA-Compatible" content="IE=edge, chrome=1" /><meta name="viewport" content="width=device-width, initial-scale=1" /><title>Falco - F# web toolkit for ASP.NET Core</title><meta name="description" content="A functional-first toolkit for building brilliant ASP.NET Core applications using F#." /><link rel="shortcut icon" href="/favicon.ico" type="image/x-icon" /><link rel="icon" href="/favicon.ico" type="image/x-icon" /><link rel="preconnect" href="https://fonts.gstatic.com" /><link href="https://fonts.googleapis.com/css2?family=Noto+Sans+JP:wght@400;700&display=swap" rel="stylesheet" /><link href="/prism.css" rel="stylesheet" /><link href="/tachyons.css" rel="stylesheet" /><link href="/style.css" rel="stylesheet" /><script async src="https://www.googletagmanager.com/gtag/js?id=G-D62HSJHMNZ"></script><script>window.dataLayer = window.dataLayer || [];
                function gtag(){dataLayer.push(arguments);}
                gtag('js', new Date());
                gtag('config', 'G-D62HSJHMNZ');</script></head><body class="noto bg-merlot bg-dots bg-parallax"><header class="pv3"><div class="mw8 center pa3"><div><nav class="flex flex-column flex-row-l items-center"><a href="/"><img src="/icon.svg" class="w3 pb3 pb0-l o-80 hover-o-100" /></a><div class="flex-grow-1-l tc tr-l"><a href="/docs" title="Overview of Falco's key features" class="dib mh2 mh3-l no-underline white-90 hover-white">docs</a><a href="https://github.com/pimbrouwers/Falco" title="Fork Falco on GitHub" alt="Falco GitHub Link" target="_blank" class="dib mh2 ml3-l no-underline white-90 hover-white">code</a><a href="https://github.com/pimbrouwers/Falco/tree/master/samples" title="Falco code samples" alt="Faclo code samples link" class="dib ml2 mh3-l no-underline white-90 hover-white">samples</a><a href="https://github.com/pimbrouwers/Falco/discussions" title="Need help?" alt="Faclo GitHub discussions link" class="dib ml2 mh3-l no-underline white-90 hover-white">help</a></div></nav></div><div class="mw6 center pb5 noto tc fw4 lh-copy white"><h1 class="mt4 mb3 fw4 f2">Meet Falco.</h1><h2 class="mt0 mb4 fw4 f4 f3-l">Falco is a toolkit for building secure, fast, functional-first and fault-tolerant web applications using F#.</h2><div class="tc"><a href="/docs/get-started.html" title="Learn how to get started using Falco" class="dib mh2 mb2 ph3 pv2 merlot bg-white ba b--white br2 no-underline">Get Started</a><a href="#falco" class="dib mh2 ph3 pv2 white ba b--white br2 no-underline">Learn More</a></div></div><div class="mb4 bt b--white-20 tc lh-solid"><a href="https://www.nuget.org/packages/Falco" class="dib center ph1 ph4-l pv3 bg-merlot white no-underline ty--50" target="_blank">Latest release: 5.0.0 (January, 29, 2025)</a></div><div class="cf tc lh-copy"><div class="fl-l mw5 mw-none-l w-25-l center mb4 ph4-l br-l b--white-20"><img src="/icons/fast.svg" class="w4 o-90" /><h3 class="mv2 white">Blazing Fast</h3><div class="mb3 white-90">Built upon core ASP.NET components.</div><a href="https://web-frameworks-benchmark.netlify.app/result?l=fsharp" target="_blank" class="dib mh2 pa2 f6 white ba b--white br2 no-underline">Learn More</a></div><div class="fl-l mw5 mw-none-l w-25-l center mb4 ph4-l br-l b--white-20"><img src="/icons/easy.svg" class="w4 o-90" /><h3 class="mv2 white">Easy to Learn</h3><div class="mb3 white-90">Designed for getting up to speed quickly.</div><a href="/docs/get-started.html" title="Learn how to get started using Falco" class="dib mh2 pa2 f6 white ba b--white br2 no-underline">Get Started</a></div><div class="fl-l mw5 mw-none-l w-25-l center mb4 ph4-l br-l b--white-20"><img src="/icons/view.svg" class="w4 o-90" /><h3 class="mv2 white">Native View Engine</h3><div class="mb3 white-90">Markup is written in F# and compiled.</div><a href="/docs/markup.html" title="View examples of Falco markup module" class="dib mh2 pa2 f6 white ba b--white br2 no-underline">See Examples</a></div><div class="fl-l mw5 mw-none-l w-25-l center mb4 ph4-l"><img src="/icons/integrate.svg" class="w4 o-90" /><h3 class="mv2 white">Extensible</h3><div class="mb3 white-90">Seamlessly integrates with existing libraries.</div><a href="https://github.com/pimbrouwers/Falco/tree/master/samples/ScribanExample" target="_blank" title="Example of incorporating a third-party view engine" class="dib mh2 pa2 f6 white ba b--white br2 no-underline">Explore How</a></div></div></div></header><div class="h100vh bg-white"><div class="cf mw8 center pv4 ph3"><main><h1 id="falco">Falco</h1>
<p><a href="https://www.nuget.org/packages/Falco"><img src="https://img.shields.io/nuget/v/Falco.svg" alt="NuGet Version" /></a>
<a href="https://github.com/pimbrouwers/Falco/actions/workflows/build.yml"><img src="https://github.com/pimbrouwers/Falco/actions/workflows/build.yml/badge.svg" alt="build" /></a></p>
<pre><code class="language-fsharp">open Falco
open Microsoft.AspNetCore.Builder

let wapp = WebApplication.Create()

wapp.Run(Response.ofPlainText &quot;Hello world&quot;)
</code></pre>
<p><a href="https://github.com/pimbrouwers/Falco">Falco</a> is a toolkit for building fast and functional-first web applications using F#. You can think of it as <a href="https://learn.microsoft.com/en-us/aspnet/core/tutorials/min-web-api?view=aspnetcore-8.0&amp;tabs=visual-studio">minimal API</a> on <em>steroids</em>.</p>
<ul>
<li>Designed for building pure F# full-stack web applications.</li>
<li>Built on the high-performance components of ASP.NET Core.</li>
<li>Seamlessly integrates with existing .NET Core middleware and libraries.</li>
</ul>
<h2 id="key-features">Key Features</h2>
<ul>
<li>Simple and powerful <a href="documentation/routing.html">routing</a> API.</li>
<li>Uniform API for <a href="documentation/request.html">accessing <em>any</em> request data</a>.</li>
<li>Native F# <a href="documentation/markup.html">view engine</a>.</li>
<li>Asynchronous <a href="documentation/response.html">request handling</a>.</li>
<li><a href="documentation/authentication.html">Authentication</a> and <a href="documentation/cross-site-request-forgery.html">security</a> utilities.</li>
<li>Built-in support for <a href="documentation/request.html#multipartform-data-binding">large uploads</a> and <a href="documentation/response.html#content-disposition">binary responses</a>.</li>
</ul>
<h2 id="design-goals">Design Goals</h2>
<ul>
<li>Provide a toolset to build full-stack web application in F#.</li>
<li>Should be simple, extensible and integrate with existing .NET libraries.</li>
<li>Can be easily learned.</li>
</ul>
<h2 id="learn">Learn</h2>
<p>The best way to get started is by visiting the <a href="https://falcoframework.com/docs">documentation</a>. For questions and support please use <a href="https://github.com/pimbrouwers/Falco/discussions">discussions</a>. For chronological updates refer to the <a href="CHANGELOG.html">changelog</a> is the best place to find chronological updates.</p>
<h3 id="related-libraries">Related Libraries</h3>
<ul>
<li><a href="https://github.com/pimbrouwers/Falco.Markup">Falco.Markup</a> - an XML markup module primary used as the syntax for <a href="https://www.falcoframework.com/docs/markup.html">authoring HTML with Falco</a>.</li>
<li><a href="https://github.com/dpraimeyuu/Falco.Htmx">Falco.Htmx</a> - a full featured integration with <a href="https://htmx.org/">htmx JS package</a>.</li>
<li><a href="https://github.com/pimbrouwers/Falco.OpenApi">Falco.OpenApi</a> - a library for generating OpenAPI documentation from Falco applications.</li>
<li><a href="https://github.com/pimbrouwers/Falco.Template">Falco.Template</a> - a .NET SDK <a href="https://learn.microsoft.com/en-us/dotnet/core/tools/custom-templates">project template</a> to help get started with Falco quickly.</li>
</ul>
<h3 id="community-projects">Community Projects</h3>
<ul>
<li><a href="https://github.com/adelarsq/falco_graphql_sample">Falco GraphQL Sample</a> - A sample showing how to use GraphQL on Falco using .NET 6.</li>
<li><a href="https://github.com/jasiozet/falco-api-with-tests-template">Falco API with Tests Sample</a> - A sample project using Falco and unit testing.</li>
<li><a href="https://github.com/galassie/FalcoSample">Falco + SQLite + Donald</a> - A demo project using Falco, <a href="https://github.com/pimbrouwers/Donald">Donald</a>, and SQLite</li>
<li><a href="https://github.com/NitroDevs/FShopOnWeb">FShopOnWeb</a> - An adaptation of the classic <a href="https://github.com/dotnet-architecture/eShopOnWeb">ASP.NET Core sample application</a> using Falco and an F# architecture.</li>
</ul>
<h3 id="articles">Articles</h3>
<ul>
<li>Istvan - <a href="https://dev.l1x.be/posts/2020/12/18/running-asp.net-web-application-with-falco-on-aws-lambda/">Running ASP.Net web application with Falco on AWS Lambda</a></li>
</ul>
<h3 id="videos">Videos</h3>
<ul>
<li>Ben Gobeil - <a href="https://youtu.be/DTy5gIUWvpo">Why I'm Using Falco Instead Of Saturn | How To Switch Your Backend In SAFE Stack | StonkWatch Ep.13</a></li>
</ul>
<h2 id="contribute">Contribute</h2>
<p>We kindly ask that before submitting a pull request, you first submit an <a href="https://github.com/pimbrouwers/Falco/issues">issue</a> or open a <a href="https://github.com/pimbrouwers/Falco/discussions">discussion</a>.</p>
<p>If functionality is added to the API, or changed, please kindly update the relevant <a href="docs">document</a>. Unit tests must also be added and/or updated before a pull request can be successfully merged.</p>
<p>Only pull requests which pass all build checks and comply with the general coding standard can be approved.</p>
<p>If you have any further questions, submit an <a href="https://github.com/pimbrouwers/Falco/issues">issue</a> or open a <a href="https://github.com/pimbrouwers/Falco/discussions">discussion</a> or reach out on <a href="https://twitter.com/falco_framework">Twitter</a>.</p>
<h2 id="why-falco">Why &quot;Falco&quot;?</h2>
<p><a href="https://docs.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel">Kestrel</a> has been a game changer for the .NET web stack. In the animal kingdom, &quot;Kestrel&quot; is a name given to several members of the falcon genus. Also known as &quot;Falco&quot;.</p>
<h2 id="find-a-bug">Find a bug?</h2>
<p>There's an <a href="https://github.com/pimbrouwers/Falco/issues">issue</a> for that.</p>
<h2 id="license">License</h2>
<p>Licensed under <a href="https://github.com/pimbrouwers/Falco/blob/master/LICENSE">Apache License 2.0</a>.</p>
</main></div></div><footer class="cl pa3 bg-merlot"><div class="f7 tc white-70">&copy; 2020-2025 Pim Brouwers & contributors.</div></footer><script src="/prism.js"></script></body></html>