Developer's Guide

Whether you're building a custom-branded storefront or looking for ways to extend Saleor, the following guide will help you achieve your goals.

First Steps

• Getting started: key concepts to understand before using Saleor.
• Installation: get Saleor running on your machine.

API Conventions

• Pagination: learn how to traverse large datasets.
• Error Handling: handle error conditions.

Development

• Products: access the products catalog.
• Checkout: the checkout flow.
• Users: creating and managing customer accounts.
• Metadata: store additional information about items.
• Extending: add custom logic to a Saleor store.
• API Reference: the full API reference.

Running Saleor

• Configuration: use environment variables to control Saleor.
• Docker: deploy Saleor to your own servers.
• Heroku: deploy Saleor to Heroku.
• Amazon S3: store uploaded media on Amazon S3.
• Google Cloud Storage: store uploaded media on GCS.
• Customizing Emails: use custom branding for transactional messages.
• Monitoring: monitor your store and collect performance metrics.

Community

• Contributing: contribute changes to Saleor's codebase.
• Frequently Asked Questions: find out if your questions were already answered.
• Support: if this guide is not enough to solve your problems.