How vtex-apps/minimum-boilerplate-theme works
Project type and purpose
• This is a front-end “theme” VTEX IO app built on the VTEX Store Framework.
• It provides a minimal starting point for building a custom storefront by defining page “blocks” and styles, then wiring them into VTEX’s runtime.
File structure
• Top-level manifest.json: declares the app’s vendor/name, and its runtime dependencies on VTEX apps.
• store/blocks/*.jsonc: each JSONC file configures one page or layout block (home, product, search, header, footer, default).
• styles/configs/style.json: theme-wide style tokens and variables.
• styles/css/vtex.store-components.css: global CSS override for Store Framework components.
• docs/README.md: documentation stub.
Key architectural insights from README
• The theme is installed/uninstalled via the VTEX CLI (vtex link, vtex install/uninstall).
• Depends on two VTEX apps: vtex.store and vtex.store-sitemap.
• Render pipeline: the Store Framework loads blocks & CSS, composes pages, and serves them via the VTEX IO CDN.
Main components
a. Developer environment
• VTEX CLI (Toolbelt)
• Local workspace & Git repo (the boilerplate code)
b. Theme App (your code)
• manifest.json (app metadata & dependencies)
• store/blocks (page composition)
• styles/configs & styles/css (visual theming)
c. VTEX IO Platform
• Store Framework (runtime that reads blocks + CSS)
• vtex.store-sitemap (auto-generates sitemap, page routing)
• vtex.store (storefront services like search, catalog, cart)
d. End user (browser)
• Fetches JS/CSS from VTEX CDN, sends events & queries to storefront services.
Relationships and data flows
• Developer → (vtex link) → Theme App registers on VTEX IO workspace
• Theme App’s manifest.json → Platform loads dependencies (vtex.store, vtex.store-sitemap)
• Store Framework → reads store/blocks/*.jsonc to assemble UI components into routes
• Store Framework → injects styles/css and style tokens from styles/configs
• End user browser → HTTP GET → VTEX CDN → serves assembled HTML/CSS/JS
• Browser interactions (search, add to cart) → VTEX storefront APIs under vtex.store
Architectural patterns & design principles
• Component-based composition via JSONC “blocks”
• Configuration-driven layouts (blocks declare child components)
• Clearly separated layers: code vs. style vs. platform services
• Extensible plugin/app model (theme is just another VTEX IO app)