Skip to content

Add readme for h3 example #986

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
m2nsp wants to merge 4 commits into
base: main
Choose a base branch
from
+48 −0
Open

Add readme for h3 example #986

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1b3aa41
add README for H3 example
m2nsp Aug 7, 2026
c778193
Add README for H3 example
m2nsp Aug 7, 2026
615e11b
Merge branch 'issue-882-add-readme-for-h3-example' of https://github.…
m2nsp Aug 7, 2026
05e3a6c
Clarify the example flow in H3 readme
m2nsp Aug 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions examples/h3/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
Fedify–H3 integration example
=============================

This is a simple example of how to integrate Fedify into an [H3]
application.

[H3]: https://h3.unjs.io/


Running the example
-------------------

1. Clone the repository:

~~~~ sh
git clone https://github.com/fedify-dev/fedify.git
~~~~

2. Go to the directory of the cloned repository:

~~~~ sh
cd fedify
~~~~
Comment thread
coderabbitai[bot] marked this conversation as resolved.

3. Trust and install dependencies using `mise`:

~~~~ sh
mise trust
mise install
~~~~

4. Go to the `h3` example directory:

~~~~ sh
cd examples/h3
~~~~

5. Open the server using Deno:

~~~~ sh
deno serve -A index.ts
~~~~

6. Lookup an actor using `@fedify/cli`:

~~~~ sh
fedify lookup http://localhost:8000/users/{identifier}
~~~~