Shopsys Platform Knowledge Base¶

Welcome to Shopsys Platform Knowledge Base! On these pages, you can find everything you need to know when you want to build your own e-commerce site based on the framework.

If you want to know more about Shopsys Platform, you can look at our README.md.

Need help?¶

If you are not able to find the desired information here, you can always ask us directly on our public slack or report an issue on GitHub. If you are struggling with Docker, Docker Troubleshooting might help you.

What is new and how to upgrade¶

In CHANGELOG.md you can find the list of all important changes in all repositories maintained in shopsys/shopsys monorepo
For step-by-step upgrade instructions, see UPGRADE.md
Thanks to our Backward Compatibility Promise, it should be clear to which versions you can upgrade safely and how we plan to maintain the code in the future

Table of Contents¶

Installation
- Application configuration, requirements, and installation guides for various platforms, including Docker.
Introduction
- Information about basic concepts and terms in Shopsys Platform.
Model
- Basics about model architecture, entities, ...
Cookbook
- Step by step how-to guides.
Functional
- How Shopsys Platform works from a user point of view.
Frontend
- Design implementation and customization, LESS, ...
Administration
- Administration menu and grids.
Frontend API
- Information about the frontend GraphQL API dedicated to connecting external storefronts or mobile apps.
Storefront
- Documentation for demo frontend client.
Extensibility
- How to customize the behavior of Shopsys Platform to suit your needs.
Asynchronous processing
- How to use and implement asynchronous processing in Shopsys Platform.
Automated Testing
- Information about available types of tests and how to run them.
Contributing
- Guidelines and handy information for Shopsys Platform contributors.

Frontend¶

FAQ¶

See FAQ and Common Issues.

Documenting your own project¶

Not only does Shopsys Platform itself need documentation, but your project also deserves its own docs. The tips for writing project documentation are written in Guidelines for Project Documentation.