examples README

The project's README from github.com/geastack/examples. As one markdown file: README.md.

GeaStack Examples

Example applications and tools for GeaStack.

This repo is the app gallery used by the simulator, embedded targets, GeaOS, Apple targets, the VS Code/Cursor extension, and marketing demos. Each example is a small package with a gea manifest in package.json.

What Is Here

Path Purpose
apps/* Gea apps. Most are TSX apps targeting web, ESP32, and/or GeaOS.
apps/*/package.json App manifest, target compatibility, scripts, and launcher metadata.
tools/dialer-browser Small browser-side helper tool for dialer workflows.
package.json Workspace marker for the examples collection.
docs Catalog and contribution guidance.

Quick Start

Run checks for an individual example:

cd apps/watch
npm install
npm run check
npm run build

Some examples have tests, mostly for a layout or a device setup. Run them with npm test in the app folder.

The web loop is driven from the simulator, which is a separate repository: geastack/simulator. Its scripts read apps out of an app project root, which they take from GEA_APPS_ROOT -- this repo, or your own. There is no default, so set it or pass --app-dir. The two checkouts do not need to be next to each other.

cd /path/to/simulator
GEA_APPS_ROOT=/path/to/examples ./targets/web/dev-web.mjs watch   # development loop
GEA_APPS_ROOT=/path/to/examples ./targets/web/build-web.sh watch  # build for web

./targets/web/dev-web.mjs --app-dir /path/to/examples/apps/watch   # or name one app

Flash a compatible board through the Gea CLI:

npx gea flash watch --board <alias>
npx gea flash watch --board <alias> --monitor

Documentation

App Manifest Basics

Every buildable app should have a package.json with a gea field:

{
  "gea": {
    "id": "watch",
    "name": "Watch",
    "entry": "index.tsx",
    "runtime": "gea",
    "targets": {
      "web": true,
      "esp32": true,
      "geaos": true
    }
  }
}

The manifest is consumed by the simulator, embedded board scripts, GeaOS, Apple targets, and the IDE extension. Keep it accurate.

Maintenance Notes

License

MIT (see LICENSE). You can ship closed-source products built on it. The only GeaStack code under a different license is the embedded board support (targets and @geastack/chips, GPL-3.0-only): shipping closed-source firmware through those needs a commercial license. Contact [email protected] for commercial terms, support and hosted builds.

examples (geastack/examples)

Searching Database…

What is this?This is the example-app gallery for GeaStack — a collection of sample Gea apps used by the simulator, embedded boards, GeaOS, Apple targets, and the VS Code/Cursor extension to test and demo the platform.
Is this a framework itself or just examples for one?It's not a framework — it's a monorepo of small Gea apps (mostly TSX) with gea manifests in their package.json, each proving one target behavior for the actual GeaStack framework hosted elsewhere.
How do I run these examples?Run npm test inside an individual app folder for apps that have tests, or point the separate geastack/simulator repo at this checkout by setting GEAAPPSROOT (or passing --app-dir) so its scripts can read the apps.
Do I need the simulator repo too?Yes — the web loop that drives these apps is run by a separate repository, geastack/simulator, and the two checkouts don't need to sit next to each other as long as the simulator is pointed at this one.
Can I ship closed-source firmware built on this?Only if you avoid the embedded board support code: everything else here is MIT, but the targets package and @geastack/chips are GPL-3.0-only, so closed-source firmware through those needs a commercial license from GeaStack.
What targets can a single Gea app support?A Gea app's package.json manifest declares target compatibility, and most apps under apps/ are TSX apps that can run on web, ESP32, and/or GeaOS at the same time.
How is the example catalog organized?Each example is its own package under apps/ with a package.json manifest; docs/EXAMPLE-CATALOG.md lists categories and target compatibility, and docs/DEVELOPMENT.md explains how to add or maintain an example.
What is the dialer-browser tool for?It's a small browser-side helper tool kept under tools/dialer-browser for dialer-related workflows, separate from the Gea app examples themselves.
Creator
geastack
Size
23.7 MB
Stars
120
Updated
CommitOct 16
Age
29d
Commits · 90 Days