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
  • The main repository
  • The Composer packages

Was this helpful?

  1. About
  2. Contributing

Repository structure

PreviousInstallation from ForkNextCode contribution process

Last updated 4 years ago

Was this helpful?

The main repository

The main ScandiPWA repository is a mono-repository, containing multiple NPM packages in the packages directory. They are managed by .

└── 📁  packages
   ├── 📁 scandipwa # theme sources
   ├── 📁 m2-theme # for building a magento2 theme
   ├── 📁 bundle-analyzer
   ├── 📁 router # the frontend routing mechanism
   └── 📁 framework

Lerna is symlinking packages between each other, which means if one NPM package contains a dependency on some other NPM package and there is a version of that package locally, it will be used instead of the one stored in the remote NPM package registry.

The main development happens in the packages/scandipwa folder, this folder structure is matching the folder structure of any other ScandiPWA project, please see below for more details.

The Composer packages

ScandiPWA extends Magento 2 BE in many different places. Almost in every aspect! We do it to ensure consistency and provide new features before the Magneto team does it, this allows us to have the broadest feature support.

  • – the module allows reaching the /serwice-worker.js in Magento 2.

  • – prior to version 4, this module was responsible for registering ScandiPWA as Magento 2 theme. Now, it only supplies the support for custom "ScandiPWA" theme type 4.

  • – an Open-Sourced fork of Scandiweb menu manager implementation, that allows for menu management (linking items to CMS, Category, Product, or any other URLs). It contains both implementation and GraphQl endpoints.

  • – a GraphQl query persistence (caching) mechanism developed prior to Magento 2 original one. Its main distinction is the usage of hashes while communicating with the server via "GET" requests. This allows using large queries without worrying about reaching the limit of characters in the URL.

  • – an Open-Sourced fork of Scandiweb slider manager implementation, that allows inserting slider widgets into the CMS content. It contains both implementation and GraphQl endpoints.

  • – this module allows the construction of CMS widgets on the front-end by responding with a pseudo-code of them from the server. This allows us to request the necessary data for a widget on the front-end keeping all template code reactive.

  • – the module which contains fixes and extensions to Magento 2 catalog GraphQl query definitions. This includes URL-rewrite-related fields, improvements for search performance, PLP/PDP context awareness, patches to catalog-related issues, and other GraphQl schema extensions.

  • – is responsible for the display of the ScandiPWA root template scandipwa_root.phtml for most pages of the store (while in Magento theme mode). It allows bypassing requests directly to Magento 2 controllers.

  • – removes the "query in the loop" issue from catalog GraphQl resolvers, making sure the entities are requested once per collection. Responsible for attribute, stocks, and image requests of products.

  • – customer information GraphQl endpoints developed prior to Magento 2 original ones. Provides email confirmation, forgot password, and reset password mutations.

  • – the module that contains an alternative implementation for Magento 2 quote (cart / checkout) related GraphQl endpoints. It's main difference to Magento 2 is that we only pass-in the quote ID for guest users, while logged-in users are resolved from a cookie. It also contains patches to original Magento 2 methods.

  • – an alternative wishlist endpoints for Magento 2 which we developed before original Magento 2 GraphQl for wishlist appeared.

  • – an extension to url-rewrites resolver that makes sure status codes returned from the server are should indeed be visible (stocks, enabled / disabled, active / inactive, etc). Also ads SKU for product URL rewrite response.

  • – an extensions to Magento 2 store configuration GraphQl. Provides 20+ missing configurations.

  •  – look and feel configurations for ScandiPWA installed in the Magento theme mode. Allows to change colors, CMA blocks, favicons from the Magento 2 admin pannel.

  • – a granular cache control for ScandiPWA, appends cache-identity tags to GraphQl responses. It is an alternative implementation to Magento 2 original solution (which we also developer prior to them). Main difference – it is event based, so all collection, repository load events are included into the response.

  • – switches the langauge code for ScandiPWA .phtml template (while installed in Magento theme mode).

  • – GraphQl endpoints for a contact form display and handling.

  • – GraphQl endpoints for Klarna payment method. Will be removed from core dependecies in the future and moved to a separate extension.

  • – an alternative compare endpoints for Magento 2 which we developed before original Magento 2 GraphQl for compare appeared.

  • – GraphQl endpoints that provide downloadable product preview and download in customer account.

  • – an extensions to Magento 2 country confiurations, providing is_state_required and localized country names.

contains more than 65 repositories, where most of them are Magento 2 modules that were previously used or are used by ScandiPWA / ScandiPWA OS extensions.

scandipwa/scandipwa
Lerna
Directory Structure
scandipwa/service-worker
scandipwa/installer
scandipwa/menu-organizer
scandipwa/persisted-query
scandipwa/slider-graphql
scandipwa/cms-graphql
scandipwa/catalog-graphql
scandipwa/route717
scandipwa/performance
scandipwa/customer-graph-ql
scandipwa/quote-graphql
scandipwa/wishlist-graphql
scandipwa/urlrewrite-graphql
scandipwa/store-graphql
scandipwa/customization
scandipwa/cache
scandipwa/locale
scandipwa/contact-graphql
scandipwa/klarna-graphql
scandipwa/compare-graphql
scandipwa/customer-downloadable-graphql
scandipwa/directory-graphql
ScandiPWA GitHub organization