MCPcopy Index your code
hub / github.com/MathewsJoseph25/create-shopify-app

github.com/MathewsJoseph25/create-shopify-app @main

Chat with this repo
repository ↗ · DeepWiki ↗ · + Follow
45 symbols 152 edges 52 files 0 documented · 0%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

create-shopify-app

This project requires you to have Bun and Docker installed on your local machine.

To install dependencies:

bun install

To run:

  1. Initiate a tunneling tool on your local machine (we recommend Cloudflare tunnels or ngrok). You'll get a tunneled url from any of those services. We'll call it TUNNEL_URL from here.
  2. Create an App on shopify partner portal.
  3. Update the shopify app url to {{TUNNEL_URL}}/auth/auth-init
  4. Add 2 callback urls to the app: {{TUNNEL_URL}}/auth/auth-callback and {{TUNNEL_URL}}/billing/billing-callback
  5. Create an .env file at the root of the project and update the env variable according to env.exmaple.
  6. Run docker-compose up at the root of the folder

Extension points exported contracts — how you extend this code

ShopInfo (Interface)
(no doc)
packages/@common/types/shop.types.ts
Locals (Interface)
(no doc)
apps/api/apiRouter.ts
Window (Interface)
(no doc)
apps/admin/components/AppContextWrapper.component.tsx
Shop (Interface)
(no doc)
packages/@common/types/shop.types.ts
RouteHandler (Interface)
(no doc)
apps/api/types.ts
AppContextType (Interface)
(no doc)
apps/admin/contexts/appContext.context.ts
BillingPlan (Interface)
(no doc)
packages/@common/types/billing.types.ts
ShopSubscriptionData (Interface)
(no doc)
packages/@common/types/billing.types.ts

Core symbols most depended-on inside this repo

trackException
called by 7
apps/api/utils/trackException.util.ts
getShopifyAuthKeys
called by 5
apps/api/services/auth/helpers/getShopifyAuthKeys.helper.ts
useAppApi
called by 4
apps/admin/hooks/useAppApi.hook.ts
fetchShopifyApi
called by 3
apps/api/utils/fetchShopifyApi.util.ts
getShopInstallUrl
called by 2
apps/api/services/auth/helpers/getShopInstallUrl.helper.ts
runInTransaction
called by 1
apps/api/utils/runInTransaction.util.ts
verifyUrlHMAC
called by 1
apps/api/services/auth/helpers/verifyShopifyUrlHmac.helper.ts
addShopifyWebhooks
called by 1
apps/api/services/auth/helpers/addShopifyWebhooks.helper.ts

Shape

Function 36
Interface 8
Enum 1

Languages

TypeScript100%

Modules by API surface

packages/@common/types/billing.types.ts3 symbols
apps/admin/components/AppContextWrapper.component.tsx3 symbols
apps/admin/app/page.tsx3 symbols
packages/@common/types/shop.types.ts2 symbols
apps/api/apiRouter.ts2 symbols
apps/admin/hooks/useAppApi.hook.ts2 symbols
apps/admin/app/billing/page.tsx2 symbols
apps/api/webhooks/index.ts1 symbols
apps/api/webhooks/helpers/verifyWebhook.helper.ts1 symbols
apps/api/webhooks/handlers/handleShopUpdate.webhook.ts1 symbols
apps/api/webhooks/handlers/handleAppUninstall.webhook.ts1 symbols
apps/api/utils/trackException.util.ts1 symbols

For agents

$ claude mcp add create-shopify-app \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact