https://github.com/elringus/bootsharp

Compile C# solution into single-file ES module with auto-generated JavaScript bindings and type definitions
https://github.com/elringus/bootsharp

bun codegen csharp deno interop js node ts typescript wasm

Last synced: 3 days ago
JSON representation

Compile C# solution into single-file ES module with auto-generated JavaScript bindings and type definitions

• Host: GitHub
• URL: https://github.com/elringus/bootsharp
• Owner: elringus
• License: mit
• Created: 2021-11-12T18:43:18.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-23T17:17:24.000Z (3 months ago)
• Last Synced: 2024-10-29T17:28:18.482Z (2 months ago)
• Topics: bun, codegen, csharp, deno, interop, js, node, ts, typescript, wasm
• Language: C#
• Homepage: https://bootsharp.com
• Size: 3.74 MB
• Stars: 667
• Watchers: 15
• Forks: 36
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  

    

  








  

  

  

  






# Use C# in web apps with comfort

Bootsharp streamlines consuming .NET C# apps and libraries in web projects. It's ideal for building web applications, where domain (backend) is authored in .NET C#, while the UI (frontend) is a standalone TypeScript or JavaScript project. Think of it as [Embind](https://emscripten.org/docs/porting/connecting_cpp_and_javascript/embind.html) for C++ or [wasm-bindgen](https://github.com/rustwasm/wasm-bindgen) for Rust.

![](https://raw.githubusercontent.com/elringus/bootsharp/main/docs/public/img/banner.png)

## Features

✨ High-level C# <-> TypeScript interop

📦 Embeds binaries to single-file ES module

🗺️ Works in browsers and JS runtimes (Node, Deno, Bun)

⚡ Generates bindings and types over C# interfaces

🏷️ Supports interop over object instances

🛠️ Allows customizing emitted bindings

🔥 Supports WASM multi-threading, AOT, trimming

## 🎬 Get Started

https://sharp.elringus.com/guide/getting-started

### Why not Blazor?

In contrast to solutions like Blazor, which attempt to bring the entire web platform inside .NET, Bootsharp facilitates high-level interoperation between C# and TypeScript, allowing to build the UI layer under its natural ecosystem using industry-standard tooling and frameworks, such as [React](https://react.dev) and [Svelte](https://svelte.dev).

### Why not `System.JavaScript`?

Bootsharp itself is built on top of [System.Runtime.InteropServices.JavaScript](https://learn.microsoft.com/en-us/aspnet/core/blazor/javascript-interoperability/import-export-interop?view=aspnetcore-8.0) introduced in .NET 7.

If you're looking to expose simple library API to JavaScript and don't need type declarations, Bootsharp would probably be an overkill. However, .NET's interop is low-level, doesn't support passing custom types by value and requires lots of boilerplate to author the bindings. It's impractical for large API surfaces.

With Bootsharp, you'll be able to just feed it your domain-specific interfaces and use them seamlessly from the other side, as if they were originally authored in TypeScript (and vice-versa). Additionally, Bootsharp provides an option to bundle all the binaries into single-file ES module and patches .NET's internal JavaScript code to make it compatible with constrained runtime environments, such as VS Code [web extensions](https://code.visualstudio.com/api/extension-guides/web-extensions).