THIS REPO IS DEPRECATED, PLEASE SEE https://github.com/scandipwa/scandipwa.github.io FOR NEW DOCS

?> Note: currently documentation is under development. Sorry for inconvenience!

ScandiPWA is a single page application (SPA) theme for Magento with advanced PWA capabilities.

ScandiPWA is based on React and utilizes GraphQL API of Magento 2.3. The problem which our solution solves and the motivation behind the chosen technology stack can be found in the introduction to ScandiPWA Technology Stack.

Implementing the SPA is challenging. There are multiple limitations which must be addressed when going for CSR. Find out more about SPA application challenges.

Our solution is not the only one providing the SPA experience in the Magento ecosystem. To understand the main differences between the existing solutions, refer to How we are different? section of the documentation.

ScandiPWA is a theme for Magento 2. It can be installed using composer on existing Magento instance.

Often, we do not have Magento 2 installed on our local host, or we do not want to install something manually - in that case, we have a docker setup (for linux, for mac, and for windows).

?> Note: we strongly recommend setting up using docker. Why? Because it allows us to exclude the environment-related issues from possible reasons when debugging & looking for solutions. There is a whole FAQ for most common docker-setup related issue.

In case you would like to use docker setup in production - see following guide.

In case you just want to run ScandiPWA locally using your remote server as a back-end, please follow this instruction.

The other way to get the ScandiPWA instance - is to contact [email protected]. We can provide you with scalable (production grade) ScandiPWA cloud setup with or without code access, multiple environments (dev, stage, prod), support and more!

If you still have questions regarding installation, please join our community chat or open issues in scandipwa/scandipwa-base repository.

ScandiPWA is fast, light-weight and simple to work with. We are claiming this, because we chose the technology stack on the front-end very carefully. Read more about the technologies we utilized in the front-end technology stack.

A lot of thought is put it the organization of the project internals. The approaches to file structure, file naming, and class naming patterns can be found in the guide to stay organized.

There are tools for VSCode and broad utility function list in the core of ScandiPWA. Read the development guide to speed up the development process.

Finally, for a deep dive into the theme architecture and build configuration refer to the technical specification.

Find information related to Docker environment in Docker setup guide.

Still have questions! Do not hesitate to ask in our Slack channel! Join it by following this link!

We are working hard to make this documentation available in the video-format! Make sure to checkout what we came up with on our YouTube channel!