Skip to content

Feature: Add a demo page — “The Big Moon House” (playground for endpoints) #95

Description

Summary

Introduce “The Big Moon House” as a creative feature/demo for the g4f.dev site: a small, self-contained demo page and API wrapper that showcases one or more AI endpoints with a themed UI, sample prompts, and example client code.

Motivation

  • Provide a friendly, high-visibility demo that helps new users explore available endpoints and example usages without reading docs.
  • Serve as a playground for testing endpoints, demonstrating rate limits, expected responses, and common pitfalls.
  • Give contributors a clear, small-scope front-end + integration task to onboard newcomers.

Proposal

  1. Add a new demo page (e.g., /demos/big-moon-house or /big-moon-house) with a moon/house themed UI that:

    • Lets users pick an endpoint from a short list (ChatGPT-like, Deepseek, Grok, Gemini, etc.)
    • Provides several curated example prompts (greeting, summarization, code assist)
    • Displays request/response pairs in an easy-to-read format with latency and status
    • Includes copy buttons for client snippets (curl, JavaScript fetch, Python requests)
    • Marks that it’s intended for demo/testing only (no auth keys shown or stored)
  2. Add a small front-end component and a lightweight client-side wrapper that calls existing public endpoints used by the site (or mocked responses when endpoints are not available).

  3. Add a short integration test or smoke test that the demo loads and renders example responses (can be a simple cypress/puppeteer check or Jest+jsdom).

Implementation notes

  • Keep scope small and optional: the demo should not add production traffic or new backend requirements. If necessary, default to mocked responses and clearly document how to enable live calls.
  • Place files under a demos/ or examples/ directory with clear README describing how to run locally and how to switch between mock and live modes.
  • Use existing site styles and components where possible to keep the design consistent.

Acceptance criteria

  • A new demo route is added and reachable locally (e.g., /big-moon-house)
  • UI allows selecting an endpoint and running at least one example prompt
  • Request and response are shown with basic metadata (status, latency)
  • Repo includes README and simple instructions for enabling live calls (if supported)
  • Basic smoke test verifies the demo renders without errors

Risks & considerations

  • Do not expose any secret keys in the demo. Live-calls should require the developer to supply their own key or default to an obviously mocked mode.
  • Keep the page accessible and performant; avoid heavy assets.

Suggested labels

  • enhancement

Notes

Name and theming are intentionally playful — feel free to rename “The Big Moon House” to better fit project tone. This issue is intended as a small, approachable feature that improves discoverability and onboarding for new users.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions