Post-Installation Configuration

Last updated:
Edit on GitHub

This document provides guidance on advanced configuration and customization of your Spryker project after completing the initial setup. These steps help you optimize and adapt the Demo Shop to your specific project needs.

Automate this configuration with the AI Dev SDK

Most of the work on this page — services, stores, and import data — is covered by AI Dev SDK skills. Each skill reads what your project actually contains rather than applying a template, and reports what it plans to change before changing it.

Skill What it does Reference
configure-services Changes what infrastructure the project runs on, or builds a new environment deploy file. Makes surgical edits to the keys it owns, leaving neighboring deploy file blocks untouched README
define-stores Creates or redefines a project’s stores and region. Clears the hardcoded store and locale literals that otherwise abort the boot README
project-data Populates, reshapes, reduces, cleans up, or removes the project’s import data — one skill for every data/import change README
spryker-import-tools Reads, filters, edits, and validates data import CSV files and manifests. Reliable where shell tools corrupt multi-line quoted fields, and catches boot-aborting data in seconds README
curate-golive-data Makes the data the project keeps production-safe before go-live — placeholder tax rates, Spryker CDN imagery, and demo accounts README

If you are setting up a new project, the Project Starter Wizard runs these skills in order from a single interview. Run them individually when you are configuring a project that already exists.

For the full list of skills and agents, see Skills and Agents.

The rest of this document describes the same configuration manually.

Manage modules

A Spryker module is a single-function unit that has well-defined dependencies and can be updated independently. Composer is used for installing and managing module dependencies. To define your strategy when implementing updates, learn about our module and feature release process.

To learn about the module versioning approach in Spryker, see Semantic Versioning: Major vs. Minor vs. Patch Release.

Clean up modules

  1. Go through the modules that came with the Demo Shop you’ve installed.
  2. Come up with the list of modules you actually need.
  3. Remove unnecessary modules by following module upgrade guides in a backwards fashion.

Configure services

  1. Define how to manage the settings in the configuration files with Configuration management.
  2. Configure services.
  3. Configure Elasticsearch.
  4. Configure queue.
  5. Configure stores.
  6. Set up cronjobs.

The configure-services skill applies steps 2 to 4 to your deploy file.

Clean up store configuration

The define-stores skill performs this cleanup, including the hardcoded store and locale literals that are easy to miss and that abort the boot when left behind.

If you chose to start with one store, clean up the configuration of the unneeded stores in the following files:

  • config/install/*
  • data/import/*
  • deploy.dev.yml
  • config_default.php
  • src/SprykerConfig/CodeBucketConfig.php

Clean up data import

The project-data skill performs this cleanup, and spryker-import-tools edits and validates the CSV files themselves.

  • In data/import, remove the files of the unneeded stores.
  • Change the default config in DataImportConfig::getDefaultYamlConfigPath().
  • Define the needed stores in CodeBucketConfig::getCodeBuckets().

Prepare for go-live

Before go-live, replace the demo values the Demo Shop ships with — placeholder tax rates, Spryker CDN imagery, and demo customer accounts. The curate-golive-data skill finds and resolves them.