Skip to content

About

FlyCommerce app SDK: app-bridge, app-server and app-emulator for building apps on FlyCommerce

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

FlyCommerce SDK

Tools for building apps on FlyCommerce: apps that merchants install into their store and use inside the FlyCommerce dashboard.

License: MIT

Packages

Preview. Preview builds are on npm under the next tag while FlyCommerce's app platform is in testing, for example npm install @flycommerce/app-server@next. The first stable release comes with the launch.

JavaScript and TypeScript

Package What it's for Install as
@flycommerce/app-bridge Your app's pages, running inside the dashboard: session tokens, navigation, title bar, dialogs, dashboard context. React hooks included. dependency of your frontend
@flycommerce/app-server Your app's Node server: check who is asking, finish installs, call the store API as the user or as the app, sign in to third-party services. dependency of your backend
@flycommerce/app-emulator A local FlyCommerce emulator (hub, store, dashboard) for local development and tests. devDependency
@flycommerce/cli The flycommerce command: sign in to the developer portal, run a development app on your store through a tunnel, release versions and submit for review. devDependency

Each package has its own version and changelog.

For components that look like the dashboard, use @flycommerce/ui.

Other languages

Not yet. Apps in any language can verify session tokens and webhooks by following spec/, with any JWT library and the REST API.

Claude Code plugins

FlyCommerce's plugins teach Claude Code the platform, one part each. They know about each other, so installing one brings in what it needs.

Plugin What it's for
flycommerce-apps Building an app merchants install, private or listed. Also installs flycommerce-api and flycommerce-ui.
flycommerce-api Calling a store's REST API, from an app or a script.
flycommerce-mcp Connecting an AI agent to a store's MCP server.
flycommerce-ui Screens built with @flycommerce/ui. Lives in the UI library's repo.

In Claude Code:

/plugin marketplace add getdokan/flycommerce-sdk
/plugin install flycommerce-apps@flycommerce

To turn them on for everyone working in a repo, add this to its checked-in .claude/settings.json:

{
  "extraKnownMarketplaces": {
    "flycommerce": { "source": { "source": "github", "repo": "getdokan/flycommerce-sdk" } }
  },
  "enabledPlugins": { "flycommerce-apps@flycommerce": true }
}

How an app fits together

  1. A merchant opens your app in their dashboard. The dashboard frames your page.
  2. Your page asks the dashboard for a short-lived session token (app-bridge) and sends it to your server.
  3. Your server verifies the token against FlyCommerce's public keys (app-server). It now knows the store and the user.
  4. To read or change store data, your server exchanges that token at the store for access as that user, or uses the app's own credential for background work.

The contract behind these steps is in spec/, with app-config.json, the file that describes the app.

Repository layout

spec/            the contract: session tokens, webhooks, app-config.json, storefront scripts
js/              the JavaScript packages (npm workspaces)
ai/claude/       the Claude Code plugins
.claude-plugin/  the plugin marketplace

Contributing and security

License

MIT

About

FlyCommerce app SDK: app-bridge, app-server and app-emulator for building apps on FlyCommerce

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages