esc
Type to search the docs
Back to catalog

hoppscotch

Draft

Open-source API development ecosystem

Utilities Homepage

Run locally

Terminal
$ npx launchfile up hoppscotch

Requires Docker Desktop. No source code needed — pulls pre-built images and starts hoppscotch with all dependencies.

Image: hoppscotch/hoppscotch-backend
Launchfile View on GitHub
# yaml-language-server: $schema=https://launchfile.dev/schema/v1
version: launch/v1
name: hoppscotch
description: "Open-source API development ecosystem"

components:
  backend:
    image: hoppscotch/hoppscotch-backend
    provides:
      - protocol: http
        port: 3170
    requires:
      - type: postgres
        set_env:
          DATABASE_URL: $url
    env:
      JWT_SECRET:
        generator: secret
        sensitive: true
      SESSION_SECRET:
        generator: secret
        sensitive: true
    health: /ping
    restart: always

  frontend:
    image: hoppscotch/hoppscotch-frontend
    provides:
      - protocol: http
        port: 3000
        exposed: true
    env:
      VITE_BACKEND_GQL_URL:
        default: "http://backend:3170/graphql"
        description: "Backend GraphQL endpoint"
      VITE_BACKEND_WS_URL:
        default: "ws://backend:3170/graphql"
        description: "Backend WebSocket endpoint"
      VITE_BACKEND_API_URL:
        default: "http://backend:3170/v1"
        description: "Backend REST API endpoint"
    depends_on:
      - "backend"
    restart: always

  admin:
    image: hoppscotch/hoppscotch-admin
    provides:
      - protocol: http
        port: 3100
    env:
      VITE_BACKEND_GQL_URL:
        default: "http://backend:3170/graphql"
        description: "Backend GraphQL endpoint"
      VITE_BACKEND_API_URL:
        default: "http://backend:3170/v1"
        description: "Backend REST API endpoint"
    depends_on:
      - "backend"
    restart: always

Required Services

postgres

Components

3 components in this Launchfile.

backendfrontendadmin

Learn More

Spec references for features used in this Launchfile.

Related Apps