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…

120 ·GitHub
Examples
这是什么？这是 GeaStack 的示例应用画廊——一组 Gea 示例应用，供模拟器、嵌入式开发板、GeaOS、Apple 目标平台以及 VS Code/Cursor 扩展用来测试和演示该平台。
它本身是一个框架，还是只是某个框架的示例？它不是框架——而是一个 monorepo，收录了小型 Gea 应用（大多是 TSX），package.json 中带有 gea 清单，每个应用为托管在别处的 GeaStack 框架验证一种目标平台行为。
这些示例怎么运行？对带测试的应用，在各自的应用文件夹内运行 npm test；或者通过设置 GEAAPPSROOT（或传入 --app-dir）把独立的 geastack/simulator 仓库指向本检出，让它的脚本能读取这些应用。
我也需要 simulator 仓库吗？需要——驱动这些应用的 Web 循环由另一个仓库 geastack/simulator 运行；只要把模拟器指向本仓库，两个检出不必相邻放置。
我可以发布基于它构建的闭源固件吗？只有避开嵌入式开发板支持代码才行：这里其余内容都是 MIT 许可，但 targets 包和 @geastack/chips 采用 GPL-3.0-only，通过它们做闭源固件需要 GeaStack 的商业许可。
单个 Gea 应用能支持哪些目标平台？Gea 应用的 package.json 清单声明目标平台兼容性，apps/ 下的大多数应用是 TSX 应用，可以同时在 Web、ESP32 和/或 GeaOS 上运行。
示例目录是如何组织的？每个示例都是 apps/ 下独立的包，带有 package.json 清单；docs/EXAMPLE-CATALOG.md 列出了分类和目标平台兼容性，docs/DEVELOPMENT.md 介绍了如何添加或维护示例。
dialer-browser 工具是做什么的？它是放在 tools/dialer-browser 下的一个小型浏览器端辅助工具，用于拨号器相关工作流，与 Gea 应用示例本身相互独立。
What are similar projects?arduino-esp32, muse-gadget-sdk, voiceshell-muse-bridge, esp-sdr, papermono-shopping-list, tinygo, PixelFonts, ESP32s3-LLM-Cluster
Which topics is it in?esp32, embedded-systems, examples, vscode, iot, embedded, apple, monorepo, hardware, cursor, sdk, gplv3
Creator
geastack
Size
23.7 MB
Stars
120
Updated
CommitOct 16
Age
28d
Commits · 90 Days