All documentation
Getting Started

Start Here: Install and Choose Your Integration

Install PulseGrid 0.2.0 and choose the correct path for Node.js, Python, browser frameworks, or raw HTTP/WebSocket clients.

Multi-language

Overview

AltraNC Connect uses the PulseGrid SDKs for realtime channels, server-side publishing, presence, history, Push and webhook verification. Official SDKs today: - JavaScript / TypeScript: npm package pulsegrid - Python: PyPI package pulsegrid Frameworks use those SDKs rather than needing a separate package for every framework: - Express, Nest-style Node services and Next.js server code use the JavaScript server SDK. - React, Vue, Angular, Vite and browser code use pulsegrid/client with a short-lived client token. - Django, Flask and FastAPI use the Python SDK from trusted backend code. Other languages can integrate through the stable HTTP and WebSocket protocol until an official SDK is released. Security rule: project secret keys belong only on trusted servers. Browser and mobile code must use short-lived client tokens.

Setup

Node.js / TypeScript 1. Install Node.js 18+. 2. Run: npm install pulsegrid@0.2.0 3. Keep PULSEGRID_PUBLIC_KEY and PULSEGRID_SECRET_KEY in server environment variables. 4. Import createPulseGrid from pulsegrid. Python 1. Use Python 3.10+. 2. Run: pip install pulsegrid==0.2.0 3. Keep PULSEGRID_PUBLIC_KEY and PULSEGRID_SECRET_KEY in server environment variables. 4. Import PulseGrid from pulsegrid. Browser / React / Vue / Angular / Vite 1. Install pulsegrid@0.2.0 in the JavaScript project. 2. Your trusted backend creates a short-lived client token. 3. Import connect from pulsegrid/client in frontend code. 4. Never ship the project secret key to the browser. Other languages Use the HTTP API for trusted server operations and the WebSocket endpoint with a short-lived client token for realtime clients.

Code example

Start Here: Install and Choose Your Integration
Node.js / TypeScript
npm install pulsegrid@0.2.0

Notes

The production default is https://www.altrancconnect.com, so baseUrl/base_url is optional unless you are using another environment. Support labels in these docs are deliberate: - Official SDK: packaged and supported directly by PulseGrid. - Framework integration: uses an official SDK inside that framework. - Protocol integration: uses HTTP/WebSocket directly; no official language SDK is claimed yet.