ScandiPWA
Create Magento AppCreate ScandiPWA AppUser ManualGitHub
  • Why Scandi
  • πŸš€Quick-start Guide
  • πŸ—ΊοΈRoadmap
  • Introduction to the Stack
    • CMA, CSA, and ScandiPWA
    • Challenges
  • Setting up Scandi
    • Storefront Mode Setup
      • Proxying requests to server
    • Magento Mode Setup
    • Existing Magento 2 setup
    • Magento Commerce Cloud setup
    • Updating to new releases
      • Storefront mode upgrade
      • Magento mode upgrade
      • CMA upgrade
      • CSA upgrade
      • Custom ScandiPWA composer dependency update
      • Local ScandiPWA Composer Package Setup
    • Docker Setup [deprecated]
      • Legacy Docker setup
      • Migrating to CMA & CSA
  • Developing with Scandi
    • Override Mechanism
      • Overriding JavaScript
        • Overriding classes
        • Overriding non-classes
      • Overriding Styles
      • Overriding the HTML / PHP
      • Parent Themes
    • Extensions
      • Creating an extension
      • Installing an extension
      • Migrating from 3.x to 4.x
      • Publishing an extension
      • Extension Terminology
    • Working With Magento
      • Magento troubleshooting
      • Working with Magento modules
      • Working with GraphQL
      • GraphQL Security
      • Working with "granular cache"
    • Developer Tools
      • Debugging in VSCode
      • ScandiPWA CLI
      • Configuring ESLint
      • CSA Commands
    • Deploying Your App
      • Build & Deploy Android app
      • Build & Deploy iOS app
  • Structure
    • Directory Structure
    • Building Blocks
      • Components
        • Styling Components
      • Routes
      • Redux Stores
      • GraphQL Queries
      • Global Styles
      • The Util Directory
      • Type Checking
    • Application assets
    • Code Style
      • JavaScript Code Style
      • SCSS Code Style
  • Tutorials
    • Customizing Your Theme
      • Styling
        • Customizing the Global Styles
        • Adding a New Font
        • Overriding a Components Styles
        • Extending a Component's Styles
      • Customizing JavaScript
        • Customizing the Footer Copyright
        • Adding a New Page
        • Adding a Section in My Account
        • Adding a Tab on the Product Page
        • Creating a New Redux Store
    • Payment Method Integration
      • Setting Up for Development
      • Redirecting to the Payment Provider
      • Handling the Customer's Return
    • Creating a Custom Widget
      • Scandi CMS System Overview
      • Creating a Magento Widget
      • Implementing the Rendering
    • Video Tutorials
      • #1 Setting up and talking theory
      • #2 Templating in React
      • #3 Overriding a file
      • #4 Styling the application
      • #5 Patterns of ScandiPWA
    • Dark Mode Extension
    • Deploying Native Apps
    • Product 3D Model Extension
      • Part 1: Magento 3D Model Uploads
      • Part 2: GraphQL API
      • Part 3: Scandi Frontend
    • Social Share, Full Extension Development
      • STEP-1 and 2 Creating Magento 2 Module
      • STEP-3 Backend Configurations Settings
      • STEP-4 Simple GraphQl and Resolver
      • STEP-5 Creating Extension, Base Redux Store
      • STEP-6 Extension plugins
      • STEP-7 GraphQL types, Helpers
      • STEP-8 Query Field and FieldList
      • STEP-9 render Plugins and MSTP Plugin, Component creation
      • STEP-10 SocialShare Component Development
      • STEP-11 SocialShare for CategoryPage
      • TASK-1 Changing LinkedIn to Twitter
      • STEP-12 Comments for Admin Users
      • STEP-13 Final, bugfixes
    • Accessing Magento 2 Controllers
      • STEP-1 Creating Magento 2 Module
      • STEP-2 - Create Magento 2 Frontend Route and Basic Controller
      • STEP-3 Accessing Magento 2 Controller, Bypassing ScandiPWA frontend
      • STEP-4 Creating ScandiPWA Extension with additional dependencies
      • STEP-5 Creating Plugin and Axios request
  • About
    • Support
    • Release notes
    • Technical Information
    • Data Analytics
    • Contributing
      • Installation from Fork
      • Repository structure
      • Code contribution process
      • Submitting an Issue
      • Publishing ScandiPWA
Powered by GitBook
On this page
  • ScandiPWA theme src structure
  • CMA (Create Magento App) structure

Was this helpful?

  1. Structure

Directory Structure

A high-level overview of how files are organized in Scandi

PreviousBuild & Deploy iOS appNextBuilding Blocks

Last updated 4 years ago

Was this helpful?

When creating an app for the first time, the folder structure of the application will look as follows:

πŸ“  my-app
β”œβ”€β”€ πŸ“„  README.md
β”œβ”€β”€ πŸ“„  composer.json
β”œβ”€β”€ πŸ“  i18n
β”œβ”€β”€ πŸ“  magento
|  β”œβ”€β”€ πŸ“  etc
|  |  └── πŸ“„  view.xml
|  β”œβ”€β”€ πŸ“„  registration.php
|  └── πŸ“„  theme.xml
β”œβ”€β”€ πŸ“  node_modules
β”œβ”€β”€ πŸ“„  package.json
β”œβ”€β”€ πŸ“  public
β”œβ”€β”€ πŸ“  src
└── πŸ“„  yarn.lock

There publicand src folders are empty. Do not panic! You will use them to . The application should compile with them being empty!

ScandiPWA theme src structure

ScandiPWA theme (aka. your ) has the same root folder structure, but much more files in the src folder. They are structured as follows:

πŸ“  src
β”œβ”€β”€ πŸ“  component # a place for all components
β”œβ”€β”€ πŸ“  query # a place for GraphQL queries
β”œβ”€β”€ πŸ“  route # a place for all root pages
β”œβ”€β”€ πŸ“  store # a Redux store declarations
β”œβ”€β”€ πŸ“  type # a PropType declarations
β”œβ”€β”€ πŸ“  util # all utility functions
β”œβ”€β”€ πŸ“„  index.js # application entrypoint
└── πŸ“„  service-worker.js # service worker entrypoint

More information about the structure and contents of these folders:

CMA (Create Magento App) structure

CMA structure is similar to the , but with a package.json file in the root directory. For more details, refer to the .

create overrides
parent theme
Building Blocks
default Magento folder structure
official CMA guide