If you have any project questions, concerns, or contribution ideas, join our #pwa Slack channel. Find out how to create an account by visiting Community Resources

Project structure

This topic covers the project structure created using the steps outlined in the Project setup tutorial.

Project Structure

The @magento/create-pwa scaffolding tool generates all the files and directories you need to run the Venia storefront.

src directory

Your storefront’s client-side code is defined in the src directory. This is where you add your own custom code for your storefront.

During the build process, Webpack scans this folder and creates bundles from these files. These bundles are small chunks of your storefront that the server provides to the browser as needed. Files outside the src and node_modules directory are never bundled and served to the browser.

After scaffolding a new project, the src directory looks like the following:

src
├── ServiceWorker
├── __tests__
├── drivers.js
├── index.css
├── index.js
├── registerSW.js
└── store.js

ServiceWorker directory

The ServiceWorker directory contains all the logic for providing service worker features. Examples of service workers features include push notifications, background sync, and even offline mode for your storefront.

The service worker also gives you the ability to intercept and handle network requests. This gives you better control over your site’s client-side caching logic.

__tests__ directory

The __tests__ directory is a suggested directory for your project’s test files. Most JavaScript test frameworks find test files using a file path pattern, which by default is usually all __tests__ directories. This directory comes from the Venia concept project template, which uses Jest for testing. Jest recommends that developers make multiple __tests__ directories nearby the components they are testing.

You can delete this directory if you do not need it or if your chosen testing framework requires a different setup.

drivers.js

The drivers.js file is a centralized module that provides non-PWA-Studio dependencies, such as GraphQL clients, React-router components, Redux components, etc. Centralizing these modules into a virtual dependency makes it easy to switch out or override these components

Access these dependencies through the virtual @magento/venia-drivers dependency:

import { Link, resourceUrl } from '@magento/venia-drivers';

Edit the entry in the browser section of the package.json file if you want to change the name.

For more information about Venia’s drivers and adapters pattern, see: Modular components

index.css

The index.css file contains the global styles that apply to all HTML tags. It also contains the CSS variables used throughout the project.

Avoid defining component specific styles in this file. Those should be defined in their component’s respective CSS module.

index.js

The index.js file is the entry point for your application. It imports the Venia application as a single component and renders it in the DOM. It also wraps it up inside components that provide the drivers and application context.

registerSW.js

This file registers the service worker when the user accesses the storefront. The contents of this file is standard, boilerplate code and does not need modifications.

store.js

The store.js file connects the Peregrine global store with your project’s UI components. Here, you can add your custom reducers and enhancers to Peregrine’s global store.

For more information about state management, see: State management

Important files outside src

webpack.config.js

The webpack.config.js is a Webpack configuration file. It uses configureWebpack from PWA Studio’s buildpack to create a configuration object for Webpack.

upward.yml

The upward.yml file is an UPWARD configuration file. It provides provides instructions for how an UPWARD server implementation should respond to a request.

The status, headers, and body values defined in the default upward.yml file uses values from the veniaResponse object. This object is defined in the venia-ui package’s upward.yml file.

Edit this file if you want to change how your project’s UPWARD server responds to requests.

template.html

The template.html file contains the template for the server-side rendered HTML code for your storefront’s application shell.

During the build process, the HtmlWebpackPlugin injects this file with dynamic data, such as project variables and imports for Webpack-generated Javascript bundles. The script saves this new file as dist/index.html. When a browser creates the initial request for your storefront application, the default upward.yml configuration tells the UPWARD server to respond with this index file.

As the JavaScript bundles load in the browser, the React components hydrate the different visual elements on the page with separate network requests.

server.js

The server.js file is the script that starts the production or development server. The script loads the NODE_ENV variable from the environment or your project’s .env file to determine which type of server to start.

Use the following values for NODE_ENV:

  • production - start a production server
  • test - start a staging server that uses staging server environment configurations
  • development - start a development server that uses the development server environment configurations

For more information on loading environment variables, see: Load environment file