@scandipwa/magento-scripts

magento-scripts

This package contains scripts and configuration used by Create Magento App.

Overview

What this package does:

• Compiles correct PHP version with all necessary extensions to run Magento on your system.
• Organize services required to run Magento on your system, such as Nginx, Redis, MySQL and Elasticsearch in Docker containers with forwarded ports to host system.
• Allows you to run multiple M2 projects simultaneously on the same machine without ports/files/context overlapping.

Requirements

Linux Requirements

Dependency list and installation guide is available in our documentation for installation on Linux!

MacOS Requirements

Dependency list and installation guide is available in our documentation for installation on Mac!

Windows Requirements

Dependency list and installation guide is available in our documentation for installation on Windows!

If you miss a requirement CMA will tell you and will give instructions or even provide a one click fix!

Usage

Start the App

# Create an App
npx create-magento-app <folder name>

cd <folder name>

# Run it with yarn
yarn start

# Or with npm
npm run start

Documentation for start command is available here.

Access Application CLI

To access Magento CLI, Composer and PHP use cli command:

# With yarn
yarn cli

# Or npm
npm run cli

This will a new instance of Bash with aliases for PHP, Composer and Magento used in Create Magento App project.

Documentation for cli command is available here.

Access Application Logs

To open logs use command logs with one of the scopes: redis, mysql, elasticsearch, nginx or magento.

# With yarn
yarn logs nginx

# Or npm
npm run logs nginx

> ... nginx logs

NOTE: you can also use name matching for logs! Like yarn logs m will show mysql logs, yarn logs ma will show magento logs and e.t.c.
Read more about this here.

---

CMA contains even more useful commands like checking application status, executing commands in Docker containers, linking a theme and importing database!