Skip to content

README.md

Latest commit

 

History

History
34 lines (23 loc) · 1.25 KB

README.md

File metadata and controls

34 lines (23 loc) · 1.25 KB

Publisher Tools - API

This package contains the Hono-based API server that powers the Publisher Tools. It runs on Cloudflare Workers and is responsible for fetching tool configurations, handling Open Payments, and managing probabilistic revenue sharing.

Endpoints

The API exposes endpoints related to the following functionalities:

  • Tool Configuration: Handles fetching the configuration for the monetization tools (see src/routes/get-config.ts).
  • Payments: Manages the Open Payments flow (see src/routes/payment.ts).
  • Probabilistic Revshare: Handles logic related to probabilistic revenue sharing (see src/routes/probabilistic-revshare.ts).

Development

To run the API server for local development, you can use the dev script.

From the project root:

pnpm -C api dev

From this directory (api/):

pnpm dev

This will start the Cloudflare Wrangler development server, which automatically reloads on file changes.

Available Scripts

  • pnpm dev: Starts the local development server.
  • pnpm build: Builds the worker for deployment without deploying it.
  • pnpm typecheck: Runs the TypeScript compiler to check for type errors.
  • pnpm deploy: Deploys the worker to your Cloudflare account.