remedy is a Hypermedia Server hosted on the bun runtime with htmx as a first-class integration.

Status: alpha

Documentation

Getting started

1mkdir my-project && cd my-project
2bunx @niarada/remedy

Now, start dropping files in the public directory.

Partials

Partials are indicated with the extension .part. Partials consist of both script and html. You may start the file with some script, but as soon as a newline followed by a tag is encountered, html will be assumed from then on.

Example:

const a = 1;
const b: string = "b";

<div>{a}</div>
<div>{b}</div>

Partials will be resolved into tagnames based on their path.

Examples:

• public/todo.part → <todo />
• public/todo/list.part → <todo-list />

These tags may be referenced in other partials.

index.part files are layouts.

Tag attributes are passed in as attributes normally are, and are available in the script. If you include an interface, the types will be properly coerced.

Example:

interface Attributes {
    page: number;
}

// Available in the script section on the Attributes object.
console.log(Attributes.page);

<div>{typeof page}</div>

<!-- Output:
    <div>number</div>
-->

Attributes can also be passed in if the partial/tag is loaded via GET:

GET /todo?id=1

More documentation is in the works.