Start Building Your Application

Installation of the Shopsys Framework is complete and now you can start building your application. Here are first steps you should start with.

Note: If you don't have a working application, install it first.

Commit migrations-lock.yml¶

Committing lock files is important because the application is then installed in the same way in all environments (most importantly in the production) and also in the same way for all team members. Notice that lock files for composer (composer.lock) and npm (package-lock.json) dependencies are already committed in your project.

git add migrations-lock.yml
git commit -m'locked migrations'

Set up domains¶

A domain can be understood as one instance of the shop. For example, just furniture can be bough on the domain shopsys-furniture.com while only electronics can be found on the domain shopsys-electro.com.

Note: Learn more about domain concept fully in Domain, Multidomain, Multilanguage article.

When you install new project, domains are set like this

• shopsys on the URL http://127.0.0.1:8000
• 2.shopsys on the URL http://127.0.0.2:8000

Read settings and working with domain to learn how to set your domains correctly. If you have project with only one domain, read how to create a single domain application. If you have project with more than two domains, read how to add a new domain.

We highly recommend to set up domains in the beginning of your project correctly. It will save you a lot of time.

Set up locales¶

A locale is a combination of language and national settings like a collation of language-specific characters. We use ISO 639-1 codes to specify locale (eg. cs, de, en, sk). Every domain has defined one locale and also administration has defined its locale.

When you install new project, locales are set like this

• shopsys (1st domain): en
• 2.shopsys (2nd domain): cs
• administration: en

In case you want to change domain locale read locale settings or in case you want to change default administration locale read locale in administration.

Set up Elasticsearch¶

We use Elasticsearch on the frontend for product searching, filtering and for fast listing of products to provide better performance. You are likely to adjust the Elasticsearch configuration for example if you have a technical shop where the inflection of product names doesn't make sense (we use inflection during searching by default).

Every domain has defined one Elasticsearch index. Definition of this index can be found in src/Shopsys/ShopBundle/Resources/definition/<domain_id>.json files. The most often change is adding fields and changing analysis to justify search behavior.

Set up routing¶

Routing is a mechanism that maps URL path to controllers and methods. You are likely to adjust routing when you need translated routes for a new locale (e.g. when you have a domain with German localization, and want to have a list of orders under URL /befehle).

We use Symfony routing, so please find more in the official documentation

You can adjust the routing in src/Shopsys/ShopBundle/Resources/config/routing_front.yml file and locale specific in src/Shopsys/ShopBundle/Resources/config/routing_front_xx.yml files.

Set up default currency¶

A default currency is a currency that is displayed when showing a price in a certain part of the system. The default currency is different for administration and for each of domains and you can adjust the default currency for each one individually.

The administration default currency is used in twig templates eg. as {{ value|priceWithCurrencyAdmin }}. The default currency for domain is used eg. as {{ cartItemDiscount.priceWithVat|price }}.

Note: Read more in a dedicated article about price filters and administration price filter.

When you install new project, default currencies are set like this

• shopsys (1st domain): CZK
• 2.shopsys (2nd domain): EUR
• administration: CZK

You can change default currencies in administration Pricing > Currencies, but this change will not last after application rebuild (operation that you do often during development).

How to set default currency permanently¶

You can adjust the demo data to match your project. This takes a bit more effort but once you adjust demo data, the change will be applied every time application is rebuilded.

How to set administration default currency

Class SettingValueDataFixture, method load()

+ $eurCurrency = $this->getReference(CurrencyDataFixture::CURRENCY_EUR);
+ $this->setting->set(PricingSetting::DEFAULT_CURRENCY, $eurCurrency->getId());

How to set first domain default currency

Class SettingValueDataFixture, method load()

+ $eurCurrency = $this->getReference(CurrencyDataFixture::CURRENCY_EUR);
+ $this->setting->setForDomain(PricingSetting::DEFAULT_DOMAIN_CURRENCY, $eurCurrency->getId(), Domain::FIRST_DOMAIN_ID);

How to set next domains default currency

Class MultidomainSettingValueDataFixture, method load()

- $defaultCurrency = $this->getReference(CurrencyDataFixture::CURRENCY_EUR);
+ $defaultCurrency = $this->getReference(CurrencyDataFixture::CURRENCY_CZK);

or you can even use switch logic to provide different default currencies for different domains like

switch ($domainId) {
    case 2: $defaultCurrency = $this->getReference(CurrencyDataFixture::CURRENCY_EUR); break;
    case 3: $defaultCurrency = $this->getReference(CurrencyDataFixture::CURRENCY_CZK); break;
    ...