Skip to main content

Quick Start

Welcome! This guide gets you moving on GGNomad — the unified travel, tourism, and entertainment platform — whether you're a traveler planning a trip, a host or operator listing inventory, or a developer building against the API.

Roadmap items

The web app is the complete product surface; ecosystem clients (CLI, SDKs, MCP server) are roadmap.

Environment selection​

All GGNomad tools and SDKs default to production endpoints. To target a different environment, set the BURDENOFF_ENV environment variable before installing or running any tool:

BURDENOFF_ENVWorkspace gatewayGlobal gatewayWeb app
prod (default)https://graphqlworkspaces.burdenoff.com/workspaces/graphqlhttps://graphql.burdenoff.com/global/graphqlhttps://app.ggnomad.com
alphahttps://alphagraphqlworkspaces.burdenoff.com/workspaces/graphqlhttps://alphagraphql.burdenoff.com/global/graphqlhttps://alphaapp.ggnomad.com
localhttp://localhost:4003/workspaces/graphqlhttp://localhost:4000/global/graphqlhttp://localhost:3000
# Production is the default — no env var needed
# Alpha
export BURDENOFF_ENV=alpha
# Local development
export BURDENOFF_ENV=local

For travelers​

1. Sign in Sign in to the GGNomad web app with your platform identity (OIDC SSO).

2. Discover Browse destinations by interest, season, and budget, or search by free text. Open a destination to see stays, tours, experiences, and events with clear pricing and availability.

3. Plan Add stays, tours, experiences, and event tickets to a day-by-day itinerary and watch the running total update as you go.

4. Book Carry the itinerary straight into a single checkout — set dates and guests, review the itemized subtotal, taxes, and fees, and confirm once. Every booking lands on one trip timeline that advances from booked to checked-out.

For hosts & operators​

1. Onboard Register as a provider — a guesthouse, tour company, or venue — and move through the verification lifecycle.

2. List Create a stay, tour, activity, or event: set location, capacity, and offering type, and add media.

3. Manage availability Open the availability calendar — per-date and seasonal rates, capacity, minimum stays, blackout dates, and an on/off toggle that closes a fully booked weekend until it reopens.

4. Run the booking queue Confirm incoming bookings and move each through check-in and completion, with every transition recorded and reflected on the traveler's trip timeline. Read host analytics — revenue, occupancy, average value, and rating — at a glance.

For developers​

GGNomad is GraphQL-first. Every request is authenticated, permission-checked, and scoped to your workspace.

1. Get a credential Issue an OAuth client or workspace-scoped API key from the developer portal.

2. Confirm connectivity Run a read query against the GGNomad API endpoint:

query Properties {
  ggnomadProperties(pagination: { skip: 0, take: 5 }) {
    id
    name
    location
    pricePerNight
  }
}
POST /workspaces/graphql
Content-Type: application/json
Authorization: Bearer YOUR_TOKEN

If this returns inventory, your token carries the ggnomad:read permission.

3. Confirm a booking Write a booking and react to the resulting booking.created event:

mutation Book($input: CreateGgnomadBookingInput!) {
  createGgnomadBooking(input: $input) {
    id
    referenceCode
    status
  }
}

Next steps​

Explore the product

Build with the API

Resources​

  • Product guides — across these docs
  • API reference — queries, mutations, and entity shapes
  • Web app — app.ggnomad.com
  • Website — ggnomad.com

For help getting started, contact the GGNomad team at [email protected].