Sparkling
  • English

      • Create a new Sparkling app

      Create a Sparkling app using the official scaffolder, then use the bundled workflow CLI to build Lynx bundles and run the native shells.

      Quick Start

      If you want a runnable project in minutes:

      Create a new project

      npm create sparkling-app@latest my-app
cd my-app

      Run native targets

      # Android
npm run run:android

# iOS
npm run run:ios

      Add Sparkling methods as needed

      npm install sparkling-storage

      Build bundles for release

      Same command regardless of package manager:

      npx sparkling build

      What you get

      • A Lynx app project (based on the default template)
      • Android and iOS native shells already wired for Sparkling
      • A working JS ↔ native pipe method example (router)
      • Developer workflow commands (build / autolink / run)

      Key folders/files created by the default template:

      • src/: Lynx/React entry points and assets
      • android/, ios/: native shells wired to Sparkling SDK
      • app.config.ts: build + routing config consumed by sparkling-app-cli
      • package.json: scripts (dev, build, run:android, run:ios)

      Prerequisites

      • Node.js 22 or 24 (required by Sparkling tools)
      • A Node package manager of your choice (pnpm, npm, yarn, or bun)
      • For running native shells:
        • Android Studio / Android SDK (Android) / JDK 11
        • Xcode 16+ + iOS Simulator (iOS)
        • Ruby (≥2.7, <3.4) for iOS build