Getting Started

Create a new CMA instance in minutes

Summary

• Make sure you have Node v12 or newer

• Install create-magento-app dependencies

• Initialize app with create-magento-app

• Enter the app's directory

• Start up the app with npm start

Install Dependencies

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.

In addition, before setting up, make sure you have installed Docker! However, if you don't know or don't want to set it up manually, for Linux and macOS systems Docker installation is automated! Windows WSL2 systems will need to install Docker Desktop manually.

See more in the detailed guides below:

Linux requirementsMacOS requirementsWindows requirements

Creating an App

To create a new app, you may choose one of the following methods:

NPX

npx create-magento-app my-app

NPM

Yarn

Running any of 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. Learn more:

Folder structure

Running the App

To start the app, navigate to its directory and run the start command:

cd my-app
npm start

This command will start Docker services, start Magento and open your app in the browser.

Create Magento App choose an available port for Magento 2 so it can vary. By default, it will use port 80 so the URL for the store will be http://localhost:80/.

ScandiPWA setup and Theme Linking

If you plan to use the ScandiPWA theme, you have to do the ScandiPWA setup and then come back to this CMA guide to do the theme linking:

Linking a Scandi Theme