README

Sylius Standard Edition

This is Sylius Standard Edition repository for starting new projects.

About

Sylius is the first decoupled eCommerce framework based on Symfony and Doctrine. The highest quality of code, strong testing culture, built-in Agile (BDD) workflow and exceptional flexibility make it the best solution for application tailored to your business requirements. Enjoy being an eCommerce Developer again!

Powerful REST API allows for easy integrations and creating unique customer experience on any device.

We're using full-stack Behavior-Driven-Development, with phpspec and Behat

Documentation

Documentation is available at docs.sylius.com.

Installation

Traditional

$ wget http://getcomposer.org/composer.phar
$ php composer.phar create-project sylius/sylius-standard project
$ cd project
$ yarn install
$ yarn build
$ php bin/console sylius:install
$ symfony serve
$ open http://localhost:8000/

For more detailed instruction please visit installation chapter in our docs.

Docker

Development

Make sure you have installed Docker on your local machine. Execute docker compose up -d in your favorite terminal and wait some time until the services will be ready. You might want to see docker logs. Then enter localhost in your browser or execute open localhost in your terminal.

Production

The simplest way to deploy your Sylius store via Docker is via docker-compose.prod.yml configuration file. To do that you need to install Docker on your VPS and define MYSQL_PASSWORD environment. Then execute docker compose -f docker-compose.prod.yml up -d command in your terminal. The MYSQL_PASSWORD env will be automatically applied to the rest of the config.

When using a Virtual Private Server (VPS) we recommend having at least 2GB of RAM memory

Quick deploy:

curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh

export MYSQL_PASSWORD=SLyPJLaye7

docker compose -f docker-compose.prod.yml up -d
docker compose -f docker-compose.prod.yml exec php bin/console sylius:fixtures:load --no-interaction

Troubleshooting

If something goes wrong, errors & exceptions are logged at the application level:

$ tail -f var/log/prod.log
$ tail -f var/log/dev.log

Contributing

Would like to help us and build the most developer-friendly eCommerce framework? Start from reading our Contribution Guide!

Stay Updated

If you want to keep up with the updates, follow the official Sylius account on Twitter and like us on Facebook.

Bug Tracking

If you want to report a bug or suggest an idea, please use GitHub issues.

Community Support

Get Sylius support on Slack, Forum or Stack Overflow.

MIT License

Sylius is completely free and released under the MIT License.

Authors

Sylius was originally created by Paweł Jędrzejewski. See the list of contributors from our awesome community.