Getting Started

Create ScandiPWA App is the recommended way to create ScandiPWA applications. It offers a modern build setup with no configuration.

Summary

  • Ensure you have Node v12 or newer on your development machine

  • npx create-scandipwa-app my-app to create a new app

  • cd my-app to enter your app's directory

  • npm start to run the app

These commands will create a new Scandi app, start it up, and open it in your browser.

Creating an App

You’ll need to have Node >= 12 on your local development machine (but it’s not required on the server). You can use n (macOS, Linux) or nvm-windows to switch Node versions between different projects.

You don’t need to install or configure tools like Webpack or Babel. They are preconfigured and hidden so that you can focus on the code.

To create a new app, use create-scandipwa-app:

NPX

npx
npm
yarn
npx
npx create-scandipwa-app my-app
npm
npm init scandipwa-app my-app
yarn
yarn create scandipwa-app my-app

To create an empty template instead of the default Scandi theme, use the --template blank option.

Expected Output

Running these commands will create a directory called my-app inside the current folder. Inside that directory, it will generate the initial project structure and install the transitive dependencies:

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

No configuration or complicated folder structures, only the files you need to build your ScandiPWA app.

Scripts

Inside the newly created project, you can run some built-in commands:

npm start or yarn start

Runs the app in development mode. Will open the http://localhost:3000 to preview changes in your default browser. The page will automatically reload if you make changes to the code. You will see the build errors and lint warnings in the console.

npm run build or yarn build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Your app is ready to be deployed.