README.md

Shopsys Framework

Shopsys Framework is a scalable e-commerce framework for fast-growing e-commerce sites created and maintained by in-house developers or outsourcing companies.

Our product provides the tools and know-how to help save thousands of developer man-hours in the short and long-term growth of e-merchants and their websites.

A typical project using our framework is a B2B or B2C site with a yearly revenue ranging from €5M to €60M, thousands of orders and hundreds of thousands of pageviews each day.

Shopsys Framework Infrastructure

Shopsys Framework Package Architecture

These are most important packages and the way they depend on each other. For more info see the article Basics About Package Architecture in our knowledge base.

Current State and a Roadmap

State in March 2018

Shopsys Framework is fully functional e-commerce platform with all basic functionality all e-commerce sites needs:

• product catalogue
• registered customers
• basic orders management
• back-end administration
• front-end full-text search and product filtering
• 3-step ordering process
• basic CMS
• support for several currencies, languages, and domains
• full friendly URL for main entities

Last stable release of Shopsys 6.1 was published at the beginning of 2018 and on this version we created several big B2C and B2B projects. Experience we got through implementations lead us to ideas and plans for next version of our Shopsys Framework. The main change is a bigger focus on performance and scalability and significant architecture changes which will provide easy upgradability. You can read a full article about our goals on our blog.

Shopsys Framework is currently in the process of architecture refactoring. Because of this fact, there will be lots of BC breaks in next few months and architecture is not consistent at the moment. So we strictly recommend to use the last stable version of Shopsys 6.1 for production - contact us and we will provide you the access for free.

Summer 2018 - Alpha

• Experimental projects to validate upgradability
• Heavy performance testing
• Security audits

September 2018 - Open beta

• Performance optimization through Elasticsearch, Redis, PostgreSQL
• Full core upgradability
• GDPR compliance
• First modules

February 2019 - Stable version

• Ready to scale
• Asynchronous Processing (RabbitMQ)
• API for front-end applications
• Module store (10 modules)
• Best practice manuals

You can learn more about our development plans on our blog.

Sites Built on Shopsys Framework

List of typical projects built on previous versions of Shopsys Framework:

• Zoopy
• Prumex
• Elektro Vlášek
• AB COM CZECH
• Knihy.cz

How to Start a New Project

The shopsys/shopsys package is a monolithic repository, a single development environment, for management of all parts of Shopsys Framework. See more information about the monorepo approach in the Monorepo article.

For the purposes of building a new project use our shopsys/project-base, which is fully ready as the base for building your Shopsys Framework project. For more detailed instructions, follow one of the installation guides:

• Installation via Docker (recommended)
• Native installation

Documentation

For documentation of Shopsys Framework itself, see Shopsys Framework Knowledge Base.

Contributing

If you have some ideas or you want to help to improve Shopsys Framework, let us know! We are looking forward to your insights, feedback, and improvements. Thank you for helping us making Shopsys Framework better.

You can find all the necessary information in our Contribution Guide.

Support

What to do when you are in troubles or need some help? The best way is to contact us on our Slack.

If you are experiencing problems during installation or running Shopsys Framework on Docker, please see our Docker troubleshooting.

Or ultimately, just report an issue.

License

We distribute our main parts of Shopsys Framework shopsys/project-base and shopsys/framework under two different licenses:

• Community License in MIT style for small to mid-size e-commerce sites with yearly total online sales less than €10.000.000
• Enterprise License

The rest of modules of Shopsys Framework including HTTP smoke testing are distributed under standard MIT license.