@scandipwa/magento-scripts 1.13.5-alpha.0 → 1.14.1-alpha.0

package/readme.md

@@ -1,150 +1,80 @@
 # magento-scripts
 
-This package contains scripts and configuration used by Create Magento App by [Create Magento App](https://github.com/scandipwa/create-magento-app).
+This package contains scripts and configuration used by [Create Magento App](https://github.com/scandipwa/create-magento-app).
 
 ## Overview
 
 What this package does:
-- Compiles correct php 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.
+- 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](https://docs.create-magento-app.com/getting-started/prerequisites/installation-on-linux)!
+
+### MacOS Requirements
+
+Dependency list and installation guide is available in our [documentation for installation on Mac](https://docs.create-magento-app.com/getting-started/prerequisites/installation-on-macos)!
+
+### Windows Requirements
+
+Dependency list and installation guide is available in our [documentation for installation on Windows](https://docs.create-magento-app.com/getting-started/prerequisites/windows-requirements)!
+
+> If you miss a requirement CMA will tell you and will give instructions or even provide a one click fix!
+
 ## Usage
 
-```bash
-> npx create-magento-app <folder name>
-> cd <folder name>
-> yarn/npm run start
-```
+### Start the App
 
-To use commands such as `composer`, `magento` and `php` with correct version run command:
 ```bash
-> yarn/npm cli
-```
-This will open bash with correct aliases to `php`, `magento` and `composer`.
+# Create an App
+npx create-magento-app <folder name>
 
-To open logs use command `logs` with one of the scopes: `redis`, `mysql`, `elasticsearch`, `nginx` or `magento`.
-```bash
-> yarn/npm run logs nginx
-> // nginx logs
+cd <folder name>
+
+# Run it with yarn
+yarn start
+
+# Or with npm
+npm run start
 ```
 
-> NOTE: you can use shortcuts for logs! Like `yarn logs m` will show `mysql` logs, `yarn logs ma` will show `magento` logs and e.t.c.
+> Documentation for `start` command is available [here](https://docs.create-magento-app.com/getting-started/available-commands/start).
 
-## Requirements
+### Access Application CLI
 
-- [Docker](https://docs.docker.com/get-docker/) ^19
-- [phpbrew](https://github.com/phpbrew/phpbrew) ^1.25
-
-For Mac
-- MacOS 10.5 and newer
-- Xcode 11 and newer You can find it.
-- [Homebrew](https://brew.sh/)
-
-## Dependencies
-
-### Ubuntu
-
-```sh
-apt-get install \
-    libcurl4-openssl-dev \
-    libonig-dev \
-    libjpeg-dev \
-    libjpeg8-dev \
-    libjpeg-turbo8-dev \
-    libpng-dev \
-    libicu-dev \
-    libfreetype6-dev \
-    libzip-dev \
-    libssl-dev \
-    build-essential \
-    libbz2-dev \
-    libreadline-dev \
-    libsqlite3-dev \
-    libssl-dev \
-    libxml2-dev \
-    libxslt-dev \
-    libonig-dev \
-    php-cli \
-    php-bz2 \
-    pkg-config \
-    autoconf
+To access Magento CLI, Composer and PHP use `cli` command:
+```bash
+# With yarn
+yarn cli
+
+# Or npm
+npm run cli
 ```
 
-### Mint Linux
+This will a new instance of Bash with aliases for PHP, Composer and Magento used in Create Magento App project.
 
-```
-apt-get install \
-    libjpeg-dev \
-    libjpeg8-dev \
-    libjpeg-turbo8-dev \
-    libpng-dev \
-    libicu-dev \
-    libfreetype6-dev \
-    libzip-dev \
-    libssl-dev \
-    build-essential \
-    libbz2-dev \
-    libreadline-dev \
-    libsqlite3-dev \
-    libssl-dev \
-    libxml2-dev \
-    libxslt-dev \
-    libonig-dev \
-    php-cli \
-    php-bz2 \
-    pkg-config \
-    autoconf \
-    libcurl4-openssl-dev 
-```
+> Documentation for `cli` command is available [here](https://docs.create-magento-app.com/getting-started/available-commands/cli).
 
-### CentsOS / Fedora
-```sh
-yum install --enablerepo=PowerTools openssl-devel \
-    libjpeg-turbo-devel \
-    libpng-devel \
-    gd-devel \
-    libicu libicu-devel \
-    libzip-devel \
-    libtool-ltdl-devel \
-    oniguruma-devel
-```
+### Access Application Logs
 
-### Arch
-```sh
-pamac install freetype2 \
-    openssl \
-    oniguruma \
-    libxslt \
-    bzip2 \
-    libjpeg-turbo \
-    libpng \
-    icu \
-    libxml2 \
-    autoconf \
-    libzip \
-    sqlite \
-    readline \
-    perl
-```
+To open logs use command `logs` with one of the scopes: `redis`, `mysql`, `elasticsearch`, `nginx` or `magento`.
+```bash
+# With yarn
+yarn logs nginx
 
-### MacOS
+# Or npm
+npm run logs nginx
 
-```sh
-sudo xcode-select -switch /Applications/Xcode.app
-```
-```sh
-brew install zlib \
-    bzip2 \
-    libiconv \
-    curl \
-    libpng \
-    gd \
-    freetype \
-    oniguruma \
-    icu4c \
-    libzip
+> ... nginx logs
 ```
 
-Additional libraries:  
-- Installed PHP with json extension.  
+> 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](https://docs.create-magento-app.com/getting-started/available-commands/logs#usage-example).
+
+---
+
+CMA contains even more useful commands like [checking application status](https://docs.create-magento-app.com/getting-started/available-commands/status), [executing commands in Docker containers](https://docs.create-magento-app.com/getting-started/available-commands/exec), [linking a theme](https://docs.create-magento-app.com/getting-started/available-commands/link) and [importing database](https://docs.create-magento-app.com/getting-started/available-commands/import-db)!