The Contribution Guide¶
This section is based on the great Symfony documentation.
Install to Contribute¶
Before you can start contributing to Sylius code or documentation, you should install Sylius locally.
To install Sylius main application from our main repository and contribute, run the following command:
$ composer create-project sylius/sylius
This will create a new sylius project in the
sylius directory. When all the
dependencies are installed, you’ll be asked to fill the
file via an interactive script. Please follow the steps. If you hit enter, the default values will be loaded.
Creating the "app/config/parameters.yml" file Some parameters are missing. Please provide them. database_driver (pdo_mysql): # - provide a database driver that you are willing to use database_host (127.0.0.1): database_port (null): database_name (sylius): # - you should rename the database to for instance `my_custom_application_name` database_user (root): # - provide the database user and password database_password (null): 1234 mailer_transport (smtp): # - if you will be testing e-mails please provide here your test account data, use `gmail` as transport for example. mailer_host (127.0.0.1): mailer_user (null): # - your test email mailer_password (null): # - and password secret (EDITME):
After everything is in place, run the following commands:
$ cd sylius # Move to the newly created directory $ php bin/console sylius:install
sylius:install command actually runs several other commands, which will ask you some questions and check if everything is setup to run Sylius properly.
This package contains our main Sylius development repository, with all the components and bundles in the
In order to see a fully functional frontend you will need to install its assets.
Having Node.js installed go to your project directory and run:
$ yarn install
And now you can use gulp for installing views, by just running a simple command:
$ yarn run gulp
For the contributing process questions, please refer to the Contributing Guide that comes up in the following chapters:
How to contribute using Sylius Vagrant¶
If you would like to contribute to the repo without worrying about environment, you can follow the “Configure Vagrant to contribute on Sylius Core” section here to setup your vagrant machine.