Skip to content

Latest commit

 

History

History
104 lines (71 loc) · 2.73 KB

installation.md

File metadata and controls

104 lines (71 loc) · 2.73 KB

Installation

Requirements

We work on stable, supported and up-to-date versions of packages. We recommend you to do the same.

Package Version
PHP >8.0
sylius/sylius 1.11.x
MySQL >= 5.7

The Open Marketplace application can serve as a foundation for your custom e-commerce marketplace application.

Before creating your application, make sure you use at least PHP 8.0 and have Composer installed.

Be aware. The project has currently a strong reference to Sylius eCommerce platform. If you have not discovered the solution yet, it is worth at least taking a look at the official Sylius documentation.

1. Create project

$ composer create-project bitbag/open-marketplace project
$ cd project

Open Marketplace as an application based on Sylius is using environment variables which configure connection with database, mailer services, vendor products limits, vendor logo directory and directory of files uploaded through messages. Default values are stored in .env file and you can customise them by creating .env.local file with variables that you want to change.

For mailer to work properly you need to customise MAILER_URL in your env.local

For database to work properly you need to customise DATABASE_URL in your env.local with your database credentials

Creating database for your project

$ bin/console doctrine:database:create
$ bin/console doctrine:schema:create

2. Install & build assets

$ yarn install
$ yarn encore dev
$ bin/console assets:install 

You can also use yarn watch to observe and build resources after saving files.

3. Run the app

$ symfony server:start // or symfony serve -d --no-tls

4. Load fixtures

$ bin/fixtures

Note: If you do not want to use our mockup data and prefer a clean installation instead, follow the Sylius installation guide here.

Optional steps

5. Run tests

Creating database for your test environment.

$ bin/console doctrine:database:create --env=test
$ bin/console doctrine:schema:create --env=test

a) PHPUnit

vendor/bin/phpunit --colors=always tests/

b) PHPSpec

vendor/bin/phpspec run

c) PHPStan

vendor/bin/phpstan analyse -c phpstan.neon -l 8 src/

d) Behat

vendor/bin/behat 

e) Coding Standard

vendor/bin/ecs check src