Installation Guide¶

This document will provide you with information about ways of developing and running Shopsys Platform project and the services that it depends on.

Quick Start with Shopsys CLI¶

For new projects, the Shopsys CLI is automatically downloaded when you create a project using Composer:

Windows Users: Run these commands inside WSL2 (Windows Subsystem for Linux).

composer create-project shopsys/project-base --no-install --keep-vcs --ignore-platform-reqs

The CLI (shopsys.phar) is automatically downloaded and the configuration wizard launches, guiding you through domain configuration, locale settings, and more.

Alternatively, you can download the CLI manually and initialize a project:

# Download Shopsys CLI manually
curl -L https://github.com/shopsys/cli/releases/latest/download/shopsys.phar -o shopsys
chmod +x shopsys

# Initialize a new project
./shopsys init my-project

See Project Initialization with Shopsys CLI for detailed documentation.

Installation using Docker¶

These guides will show you how to use prepared Docker Compose configuration to simplify the installation process. Docker contains complete development environment necessary for running your application so you do not need to install and configure the whole server stack (Nginx, PostgreSQL, etc.) natively in order to run and develop Shopsys Platform on your machine.
All the services needed by Shopsys Platform like Nginx or PostgreSQL run in Docker and your source code is automatically synchronized between your local machine and Docker container in both ways.
That means that you can normally use your IDE to edit the code while it is running inside a Docker container.

Installation without Docker¶

If your system is not listed above, or you do not want to use Docker containers, you can still install it natively. To develop and run Shopsys Platform natively you can read the native installation document. This document is not step-by-step guide since support for all operating systems and their versions is very hard to maintain.