README

Shopware

Modern open source e-Commerce

Shopware 6 is an open headless commerce platform powered by Symfony 7 and Vue.js 3 that is used by thousands of shops and supported by a huge, worldwide community of developers, agencies, and merchants.

If you like Shopware 6, give us a ⭐️  on GitHub!

• 🙋‍♂️  Be part of shopware! ‍ We are hiring! 🙋
• 🌎  Discover our website
• 🧩  Browse more than 3,100 extensions in our community store
• 📖  Learn how to develop extensions and everything else about the tech behind Shopware via our developer docs.
• 🉐  Translate Shopware or help by contributing to existing languages
• 🛠  Report bugs in our issue tracker
• 💡  Give us feedback or vote existing ideas
• 👪  Exchange with other Shopware developers in our own Community Hub or the Discord community
• 🗨  Help and get helped on Stack Overflow or in our Community forum

Table of contents

• Table of contents
• Project overview
  • Platform and Framework
• Installation
  • Production setup
  • Code Contribution
    • Contribution setup
• The Shopware CLA
• Authors & Contributors
• License
• Bugs & Feedback
• Reporting security issues
• Extending Shopware

Project overview

To discover the features of Shopware and what sets us apart from other ecommerce systems, take the feature tour on the Shopware home page.

From a developer's perspective, here are some highlights that make Shopware easy and fun to work with:

Platform and Framework

Shopware is primarily based on Symfony and Vue.js. It is a fully functional ecommerce platform, but it also serves as an ecommerce framework.

Shopware is:

• a ready-to-use shopping cart system.
• a vendor dependency in your flex project.
• API-first.
• extensible through plugins:
  • Harness the full power of Symfony by creating bundles and loading them as part of the application.
• extensible through apps:
  • A modern, lightweight but powerful way to add functionality, requiring very little Shopware-specific knowledge.
• headless if you need it to be.

Installation

Production setup

The easiest way to run a Shopware shop is by booking a commercial plan in the Shopware cloud, a fully managed setup, ready to use.

The recommended way for on-premise shops is to install Shopware through the flex template. To unlock the full potential Shopware has to offer, commercial plans are also available for on-premise.
These plans enrich your shop with unique functionality, giving you an additional advantage over your competition.

There is a list of hosting partners, who offer a pre-installed shop, making your start a lot faster.

We also provide a web-based installer, installation instructions on docs, and the course walks you through the necessary steps.

Code Contribution

If you have decided to contribute code to Shopware and become a member of the Shopware community, We appreciate your hard work and want to handle it with much respect. To ensure the quality of our code and our products, we have created a guideline that we all should endorse. It helps us collaborate with you. Following these guidelines will help us integrate your changes into our daily workflow effectively.

Read more in our contribution guideline on how to contribute code.

Contribution setup

For Contributing setup see CONTRIBUTING.md. If you want to run Shopware locally for extension/theme/project development, check out the development environment setup.

The Shopware CLA

When submitting your code to Shopware, you are required to sign our CLA (Contributor License Agreement) automatically. This CLA ensures that Shopware will stay an open and living product. In short, you give the explicit right to use your code in Shopware to shopware AG.

Authors & Contributors

Shopware is built with the help of our community.

You can find an overview of everyone who contributed to the platform repository in the official GitHub overview. Additionally, numerous people contribute to the ecosystem through activities unrelated to the codebase. Thank you all for being part of this!

License

Shopware 6 is completely free and released under the MIT License.

Bugs & Feedback

No software is perfect, and Shopware is no exception. Should you spot a bug, please report it in our issue tracker.

If you want to suggest features or how certain parts of Shopware 6 work, we'd be happy to hear from you.

Reporting security issues

Please review our security policy.

Extending Shopware

There are already a lot of extensions available in the Shopware store.

After setting up Shopware locally for development, you can start with our extension guides in the documentation.

The preferred way of extending Shopware is through the App System. If the feature you want to implement needs direct access to the Shopware process and the database, you can also use the plugin system.
You can find an overview and differentiation in the documentation.