geastack/examples: Example Gea purposes and instruments — the app gallery utilized by the simulator, the embedded targets, GeaOS and the Apple targets. · GitHub


Example purposes and instruments for GeaStack.

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

Path Purpose
apps/* Gea apps. Most are TSX apps concentrating on internet, ESP32, and/or GeaOS.
apps/*/package deal.json App manifest, goal compatibility, scripts, and launcher metadata.
instruments/dialer-browser Small browser-side helper software for dialer workflows.
package deal.json Workspace marker for the examples assortment.
docs Catalog and contribution steerage.

Run checks for a person instance:

cd apps/watch
npm set up
npm run test
npm run construct

Some examples have checks, principally for a format or a tool setup. Run them with
npm check within the app folder.

The internet loop is pushed from the simulator, which is a separate repository:
geastack/simulator. Its scripts learn
apps out of an app undertaking root, which they take from GEA_APPS_ROOT — this
repo, or your personal. There isn’t any default, so set it or cross --app-dir. The two
checkouts don’t must be subsequent to one another.

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

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

Flash a appropriate board via the Gea CLI:

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

Every buildable app ought to have a package deal.json with a gea discipline:

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

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

  • Keep examples small and centered. A superb instance proves one habits clearly.
  • Prefer shared framework APIs over target-specific hacks inside examples.
  • Add checks for examples with non-trivial logic, physics, or parsing.
  • Update the catalog docs when including, renaming, hiding, or altering goal
    compatibility for an app.

MIT (see LICENSE). You can ship closed-source merchandise constructed on it. The solely GeaStack code underneath a special license is the
embedded board assist (targets and @geastack/chips, GPL-3.0-only):
transport closed-source firmware via these wants a business license.
Contact [email protected] for business phrases, assist and hosted builds.



Source link