Documentation

Comprehensive guides, technical references, and API documentation for building with XGGSGS.

✅ Getting Started

Installation

npm i @xggsgs/core
# or
yarn add @xggsgs/core

Install the core SDK

📘 Core Concepts

Initialization

import { initXggsgs } from '@xggsgs/core'

const app = initXggsgs({
    apiKey: 'YOUR_API_KEY',
    env: 'production'
})

Initialize the XGGSGS runtime with your API key and environment configuration.

Event System

  • • Powerful pub/sub architecture for component communication
  • • Real-time updates with event batching
  • • Cross-tenant event isolation

🔍 API Reference

Core Methods

start()
Initializes the framework's runtime services.
connect()
Establishes data streaming connection.
render()
Renders components to the virtual dom.
For details, see the API Deep Dive.

🎮 Developer Guides

Creating Your First Module

  • npm run create:module
  • Configure module manifest.json
  • Implement lifecycle hooks
Read the full guide →