Oxpecker documentation

Oxpecker

Welcome to Oxpecker! An F# library designed to supercharge your web development with ASP.NET Core, Htmx, and Solid.js. Oxpecker began as a functional wrapper for ASP.NET Core Endpoint routing (think F#-friendly “Minimal APIs”) and has evolved into a comprehensive fullstack solution. Our monorepo includes all related projects, with documentation conveniently located in README.md files for each project.

🚀 Performance Alert! Oxpecker is recognized as one of the fastest .NET web frameworks in several categories in the TechEmpower benchmark.

The server-side core of Oxpecker is a refined version of the acclaimed Giraffe, largely maintaining Giraffe’s successful API (hence the name!). Key enhancements include optimized core types, better performance, simplified handler logic, and the removal of outdated functionalities.

Why Choose Oxpecker?

• Blazing Fast: Benefit from top-tier performance, as validated by TechEmpower benchmarks.
• Functional & F#-Friendly: Enjoy an idiomatic F# experience on top of ASP.NET Core.
• Fullstack Power: Seamlessly integrate backend and frontend with Htmx and Solid.js.
• Modern ASP.NET Core: Leverages native Endpoint routing for robust and flexible web applications.
• Rich Feature Set: From view engines to Htmx integration, Oxpecker has you covered.

Dive Deeper - Features:

• Native ASP.NET Core Endpoint routing integration
• Fast ViewEngine with a convenient DSL for HTML
• OpenApi integration
• Htmx integration
• Strongly typed route parameters
• Endpoint handlers and endpoint middlewares, offering flexible composition
• Effortless JSON binding and serialization
• Simplified Form binding
• Built-in Model validation
• Easy URL parameters binding
• Response caching capabilities
• Streaming support
• Authorization mechanisms
• eTag support
• Comprehensive IResult support
• A wealth of useful HttpContext extensions

Get Started Quickly:

Ready to build something amazing?

• Empty template - Your basic starting point for server apps.
• Empty Solid template - For frontend Solid.js based applications.

Explore Our Examples:

See Oxpecker in action:

• Fullstack CRUD - Example with functional DI on the backend.
• HTMX Contact App - A sample Htmx application.
• ASP.NET WeatherApp (Oxpecker style)
• Frontend SPA (TodoList) - SPA application without a backend.
• MCP Server & Client - Model Context Protocol example.
• Feature Showcase - A dump of different server features all in one place.

Learn More - Articles & Insights:

Medium posts from the creator:

• Oxpecker Introduction
• 7 reasons to try Oxpecker.ViewEngine
• Oxpecker vs Blazor
• Oxpecker.Solid introduction

Comprehensive Documentation:

• Oxpecker Core
• Oxpecker.ViewEngine
• Oxpecker.Htmx
• Oxpecker.OpenApi
• Oxpecker.Solid
• Migrating from Giraffe

Contributing & Development Lifecycle:

• develop branch: This is our active development branch. Projects are linked using project references. Please send your Pull Requests here!
• main branch: This is our production branch. Projects and examples use NuGet (or npm) packages. Releases are published from this branch.

We welcome contributions! Check out the develop branch to get started.

Official Packages:

Find Oxpecker on NuGet:

• Oxpecker
• Oxpecker.ViewEngine
• Oxpecker.Htmx
• Oxpecker.OpenApi
• Oxpecker.Solid
• Oxpecker.Solid.FablePlugin

❤️ Support Oxpecker’s Growth!

Oxpecker is a passion project, and your support can make a huge difference! If you find Oxpecker valuable, or if you’d like to see it continue to evolve and improve, please consider becoming a sponsor.

Your contributions help us:

• Dedicate more time to development and new features.
• Improve documentation and examples.
• Provide faster community support.
• Keep the project healthy and actively maintained.

👉 Become a Sponsor on GitHub

Every bit of support is greatly appreciated and helps us build a better future for F# web development with Oxpecker!