You are browsing the latest version of the documentation which is not released yet. See the current stable version instead.

Native Installation

This document will provide you with the general information that is needed for running Shopsys Framework on different operation systems like (Windows, Mac, Linux, ... ), however it is not a step-by-step guide, since it would be very difficult to maintain all operation systems and their versions.

First it is truly essential to read and understand the articles about requirements and configurations for Shopsys Framework application.

  1. Application Requirements
  2. Application Configuration
  3. Native Installation Troubleshooting

After you read the articles you are ready to start with the creating and building the Shopsys Framework project.

Create new project from Shopsys Framework sources

php -d memory_limit=-1 <PATH TO COMPOSER or COMPOSER.PHAR> create-project shopsys/project-base --keep-vcs

Notes

  • The --keep-vcs option initializes GIT repository in your project folder that is needed for diff commands of the application build and keeps the GIT history of shopsys/project-base
  • We have set memory limit to -1 for composer because of the increased memory consumption during the dependencies calculation

Note

During the execution of composer create-project, there will be installed 3-rd party software as dependencies of Shopsys Framework by composer with licenses that are described in document Open Source License Acknowledgements and Third-Party Copyrights

Create databases

php phing db-create
php phing test-db-create

Hint

In this step you were using multiple Phing targets.
More information about what Phing targets are and how they work can be found in Console Commands for Application Management (Phing Targets)

Build application

php phing build-demo-dev

Note

During the execution of build-demo-dev phing target, there will be installed 3-rd party software as dependencies of Shopsys Framework by composer and npm with licenses that are described in document Open Source License Acknowledgements and Third-Party Copyrights

Run integrated HTTP server

First follow installation instructions for the symfony binary which provides its own web server.

Then you can run integrated webserver for the first domain:

symfony server:start

If you need to run second domain, you can use a different port for that.
First update your config/domains_urls.yaml file and set url of second domain to http://127.0.0.1:8001

Then you can run integrated webserver for the second domain:

symfony server:start --port 8001

Tip

With Symfony Local Web Server you can easily setup TLS to detect problems with mixed content early, and to run libraries that only run in HTTPS.
For more information and instructions please refer to the official Symfony documentation

Tip

You can also use local domain names (eg. http://shopsys.wip) instead of 127.0.0.1:8000
For more information and instructions please refer to the official Symfony documentation

See it in your browser!

Open http://127.0.0.1:8000/ to see running application.

You can also login into the administration section on http://127.0.0.1:8000/admin/ with default credentials:

  • Username: admin or superadmin (the latter has access to advanced options)
  • Password: admin123

And now you can start building your application.