Cloudflare Workers

9min
You can use the routes of the cloudflare workers to expose your mini-app.
This section is being reviewed and expanded.
﻿Hono is a minimal, ultrafast web framework for Cloudflare Workers, making it an excellent choice for serverless deployments.
Before starting this tutorial please create a Cloudflare account.
Initial Setup
Install de Cloudflare CLI
bash
npm install -g wrangler
npm install -g wrangler
﻿
Create a new worker project
bash
wrangler init mini-app-metadata
cd mini-app-metadata
wrangler init mini-app-metadata
cd mini-app-metadata
﻿
Add Hono as dependency
npm
npm install hono
npm install hono
﻿
Install the SDK
npm
yarn
yarn add @sherrylinks/sdk
yarn add @sherrylinks/sdk
﻿
Creating the Endpoint
Edit the src/index.js file:
index.js
import { Hono } from 'hono';

const app = new Hono();

const metadata = {
  name: "Mini-app Name",
  description: "Brief description of the mini-app",
  version: "1.0.0",
  endpoint: "https://your-domain.com/api/mini-app",
  parameters: [
    {
      name: "parameter1",
      type: "string",
      required: true,
      description: "Description of the parameter"
    }
  ]
};

app.get('/metadata', (c) => {
  return c.json(metadata);
});

export default app;

import { Hono } from 'hono';

const app = new Hono();

const metadata = {
  name: "Mini-app Name",
  description: "Brief description of the mini-app",
  version: "1.0.0",
  endpoint: "https://your-domain.com/api/mini-app",
  parameters: [
    {
      name: "parameter1",
      type: "string",
      required: true,
      description: "Description of the parameter"
    }
  ]
};

app.get('/metadata', (c) => {
  return c.json(metadata);
});

export default app;
﻿
Preview the worker locally
terminal
wrangler dev
wrangler dev
﻿
Deploying to Production
Your metadata endpoint will be available at
https://mini-app-metadata.workers.dev
﻿
Updated 29 Nov 2024
Did this page help you?
NextJS
Validating Metadata