create-example-app-with-integration

Creates and tests Fedify example applications for web framework integration packages.

1.0k|132|Updated Mar 2, 2024
One-click install
npx skills add https://github.com/fedify-dev/fedify --skill create-example-app-with-integration
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-example-app-with-integration
Source: https://github.com/fedify-dev/fedify/tree/main/.agents/skills/create-example-app-with-integration
Command: npx skills add https://github.com/fedify-dev/fedify --skill create-example-app-with-integration

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Building a consistent, working example application for each Fedify web framework integration requires repeating the same federation setup, routing, design system, and test registration work, which is error-prone when done manually.

Core Features & Use Cases

  • Standardized example scaffolding: Copies template files (federation.ts, store.ts, logging.ts, public assets) and adapts them to a target web framework for both Deno and Node.js environments.
  • Architecture and design conformance: Implements the shared routing spec (actor profiles, posts, follow/unfollow, SSE updates) and the light/dark design system defined in ARCHITECTURE.md and DESIGN.md.
  • Automated verification: Registers the example in the test registry and validates it with mise test:examples using a pinggy.io tunnel, then runs lint and format checks.
  • Use Case: When adding a new @fedify/<framework> integration package, use this Skill to generate the matching example app under examples/ and confirm it federates correctly before merging.

Quick Start

Create an example application for the Hono framework integration and test it with mise test:examples.

Frequently Asked Questions about create-example-app-with-integration

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a Fedify example app for a new web framework?

Copy the template files from the example directory, adapt federation.ts, store.ts, and the app entry point to the framework, then implement the routes and pages defined in ARCHITECTURE.md and DESIGN.md. Register the result in examples/test-examples/mod.ts and run mise test:examples.

How do I test a Fedify example application?

Run mise test:examples followed by the example's registered name to test only that example, or run it without arguments for the full suite. The tests use the pinggy.io tunneling service, so the tunnel must be usable or tests may hang or fail.

Does the example app support both Deno and Node.js?

Yes, unless the framework itself prevents it. Add a deno.json for Deno support and a package.json with tsdown.config.ts for Node.js, then register the example path in the root deno.json workspace and pnpm-workspace.yaml.

What if the framework has no frontend or prescribed entry point?

Use Hono when a backend-only framework needs a frontend pairing and there is no natural match. Default to src/main.ts as the entry point, define the app in src/app.ts, and import src/logging.ts to initialize Logtape.

Why does the example test fail or never finish?

The most common cause is an unusable pinggy.io tunneling service, which the tests need to expose the local server. If tests cannot run, start the server manually and verify federation with curl using an Accept: application/activity+json header against /users/demo.