How vtex-apps/my-account works
Project Type and Purpose
• Full-stack VTEX IO app (“My Account” hub)
• Purpose: centralize customer data (profile, addresses, orders, cards) and expose extension points for other apps (e.g. vtex.my-orders-app).
• Key builders in manifest.json: react (3.x), node (GraphQL resolvers), store (0.x), messages (i18n).
File Structure
• Top-level “react” folder: UI code (TSX, GraphQL queries, Router, pages, components, hooks, utils, typings).
• Top-level “node” folder: GraphQL schema (graphql/schema.graphql), resolvers (node/resolvers), service.json (VTEX platform bindings).
• “store” folder: store/interfaces.json & store/plugins.json – configuration for Store Builder extension points.
• “messages” folder: context.json for internationalization (Messages Builder).
• “my-account-extension-example”: reference sample illustrating how to use extension points.
README for Additional Insights
• Clarifies how clients add pages/links via store/interfaces.json + store/plugins.json.
• Shows React integration points: AppRouter, ProfileEdit, ProfileFormBox.
• Describes the flow of data through GraphQL queries/mutations (e.g., getProfile, saveAddress).
Main Components and Their Interactions
A. VTEX IO Core Platform
– Hosts your app, orchestrates builders, and provides render-runtime.
B. Front-end (React Builder)
– Components: AppRouter, Menu, Profile, Addresses, Loaders, shared UI.
– GraphQL queries (.gql) & auto-generated typings.
– Internationalization via messages/context.json.
C. Back-end (Node Builder)
– GraphQL server: schema.graphql + resolvers → orchestrates calls to Master Data, other VTEX APIs.
– service.json defines HTTP clients for external VTEX services.
D. Store Builder
– store/interfaces.json: declares extension point IDs → React components.
– store/plugins.json: mounts components into CMS extension slots (menu links, pages).
E. Messages Builder
– Provides locale/context for user-visible strings (messages/context.json).
F. Example Extension (“my-account-extension-example”)
– Illustrates how a third-party app can plug into the menu and page extension points.
Relationships & Data Flows
1. User opens “/account” URL in the storefront → VTEX render-runtime kicks in.
2. React bundle loads (DefaultPage → AppRouter), renders menu & routes.
3. Components fire GraphQL queries/mutations (via vtex.render-runtime fetch) to the Node GraphQL server.
4. Node resolvers translate GraphQL operations into calls to VTEX services (defined in service.json).
5. Responses flow back to React UI; state updates and pages re-render.
6. Store Builder injection points let additional React components (from your app or third-party apps) appear in the menu or as sub-pages.
7. Messages Builder injects translated strings into the React UI at runtime.
Architectural Patterns & Principles
• Builder pattern (VTEX IO builders: react, node, store, messages).
• Component-based UI (high cohesion, reuse).
• GraphQL façade – single endpoint hiding multiple backend calls.
• Extension points – loose coupling, open-closed principle.
• Separation of concerns – UI vs. API layer vs. store config vs. i18n.