brk_website

Crates.iobrk_website
lib.rsbrk_website
version0.1.0-beta.0
created_at2026-01-25 13:27:48.779255+00
updated_at2026-01-25 13:27:48.779255+00
descriptionStandalone website server for BRK
homepagehttps://bitcoinresearchkit.org
repositoryhttps://github.com/bitcoinresearchkit/brk
max_upload_size
id2068760
size3,196,244
(nym21)

documentation

README

brk_website

Website serving for BRK with minimal dependencies.

Features

  • Embedded assets: Website files compiled into binary
  • Filesystem mode: Serve from custom path for development
  • SPA support: Routes without extensions fallback to index.html
  • ImportMap: Auto-generates import maps for hashed assets

Usage

use brk_website::{Website, router};

// Create router for website
let website_router = router(Website::Default);

// Merge with your app
let app = your_api_router.merge(website_router);

Website Enum

Variant Description
Default Filesystem in debug, embedded in release
Filesystem(path) Always serve from specified path
Disabled No routes registered

Standalone Server

See the website example for a complete standalone server with compression, tracing, and other middleware.

cargo run -p brk_website --example website

Dependencies

  • axum - HTTP routing
  • include_dir - embedded assets
  • importmap - asset hashing
Commit count: 1045

cargo fmt