How limesharp/shopify-onboarding works
This is a read-only, multi-store Shopify audit-data collector. Its main workflow loads each store’s credentials, refreshes tokens when needed, verifies access, collects configuration and privacy data through the Admin GraphQL API, then writes JSON and ClickUp-ready Markdown. A separate authorization workflow obtains and persists offline tokens through a relay. The README documents manual app/integration review as a product capability, but no automated inventory is implemented. Query-module call paths are shown where excerpts support them; relay internals were not sampled.
Main entry points: index.ts Multi-store runner · client.ts Admin API client · auth.ts OAuth CLI · store-setup.ts Store setup queries
Components 19
Access and credentials
- OAuth CLI
src/auth.ts - OAuth relay
src/relay.ts - Token exchange
src/auth.ts - Environment writer
src/env-writer.ts - Store configuration
src/config.ts - Token refresh
src/token-refresh.ts
Audit collection
- Multi-store runner
src/index.ts - Admin API client
src/client.ts - Connectivity check
src/queries/auth-check.ts - Store setup queries
src/queries/store-setup.ts - Query helpers
src/queries/helpers.ts - Apps and integrations
src/queries/apps-and-integrations.ts - Tracking and compliance
src/queries/tracking-compliance.ts
Audit outputs
- JSON writer
src/output.ts - ClickUp documents
src/clickup-doc.ts - Audit files
output
External systems
- Shopify stores
- Manual app review
Other components
- Operator
Connections 27
- Operator → OAuth CLI: starts authorization
README.md - OAuth CLI → OAuth relay: polls for code
src/auth.ts - Shopify stores → OAuth relay: approves installation
README.md - OAuth CLI → Token exchange: exchanges code
src/auth.ts - Token exchange → Shopify stores: requests token
src/auth.ts - OAuth CLI → Environment writer: saves credentials
src/auth.ts - Token refresh → Environment writer: persists refreshed tokens
src/token-refresh.ts - Operator → Multi-store runner: runs collection
README.md - Multi-store runner → Store configuration: loads stores
src/index.ts - Multi-store runner → Token refresh: refreshes tokens
src/index.ts - Multi-store runner → Admin API client: builds client
src/index.ts - Multi-store runner → Connectivity check: verifies access
src/index.ts - Multi-store runner → Store setup queries: collects setup
src/index.ts - Multi-store runner → Apps and integrations: runs section
src/index.ts - Multi-store runner → Tracking and compliance: collects compliance
src/index.ts - Connectivity check → Admin API client: requests shop data
src/queries/auth-check.ts - Store setup queries → Admin API client: requests settings
src/queries/store-setup.ts - Tracking and compliance → Admin API client: requests policies
src/queries/tracking-compliance.ts - Store setup queries → Query helpers: uses pagination
src/queries/store-setup.ts - Tracking and compliance → Query helpers: uses error handling
src/queries/tracking-compliance.ts - Multi-store runner → JSON writer: writes results
src/index.ts - Multi-store runner → ClickUp documents: formats summaries
src/index.ts - JSON writer → Audit files: writes JSON and Markdown
README.md - ClickUp documents → Audit files: generates summaries
README.md - Shopify stores → Admin API client: serves GraphQL data
README.md - Operator → Manual app review: reviews app inventory
README.md - Manual app review → Shopify stores: checks admin settings
README.md