Saleor Quickstart

Run all Saleor services on the same environment from one repository using commerce as code to build your own store with your own products and content models.

📰 Saleor Blog • 🐦 Twitter • 💬 Discord Community

Join our Discord community to get help and discuss the project!

About

What is Saleor Quickstart?

This repository provides the easiest way to start local development with all the major Saleor services using Tilt:

• Core GraphQL API
• Dashboard
• Storefront
• Mailpit (Test email interface)
• Jaeger (APM)
• Payment Service
• The necessary databases, cache, etc.

Keep in mind this repository is for local development only and is not meant to be deployed in any production environment!

Initial Setup

Requirements

• macOS/Linux: Supported natively
• Windows: WSL (Windows Subsystem for Linux) is required. Please install and configure WSL2 before proceeding with installation.
  • WSL Installation Guide
  • Use Ubuntu or Debian as your WSL distribution for best compatibility
  • All commands should be run from within your WSL terminal, not PowerShell or CMD

Option 1: Using Installation Script (Recommended)

1. Clone the repository:

git clone https://github.com/saleor/quickstart.git
cd quickstart

2. Run the installation script:

# Make the script executable
chmod +x ./install.sh

# Run the installation script
./install.sh

The script will automatically check and install all requirements, including:

• Docker Desktop
• Tilt
• Kubernetes setup
• jq (JSON processor)
• Required Docker images

Option 2: Manual Installation

First, ensure you have the following requirements:

1. Docker Desktop

   • Windows/MacOS: Minimum 5 GB of memory required
   • Windows/MacOS: Enable file sharing for the project directory
   • Linux: No special configuration needed
   • Required images:

     docker pull ghcr.io/saleor/saleor:latest

2. Tilt

   • macOS: brew install tilt
   • Windows: scoop install tilt
   • Linux: curl -fsSL https://raw.githubusercontent.com/tilt-dev/tilt/master/scripts/install.sh | bash

3. jq - JSON processor used in scripts

   • macOS: brew install jq
   • Ubuntu/Debian: apt-get install jq
   • Windows: scoop install jq or download from the official website

4. Kubernetes

   • Enabled in Docker Desktop
   • No additional installation needed

Then follow these steps:

1. Enable Kubernetes in Docker Desktop:

   • Open Docker Desktop
   • Go to Settings -> Kubernetes
   • Check "Enable Kubernetes"
   • Click "Apply & Restart"
   • Windows/MacOS: Make sure you have dedicated at least 5 GB of memory (Settings -> Resources -> Advanced)

2. Clone the repository:

git clone https://github.com/saleor/quickstart.git
cd quickstart

3. Start the development environment:

tilt up

4. Open Tilt UI in your browser:

tilt up --web

5. Default Saleor Dashboard Admin Access:
   • Email: [email protected]
   • Password: admin

Where is everything running?

• Saleor Core (API) - http://localhost:8000
• Saleor Dashboard - http://localhost:9000
• Saleor Storefront - http://localhost:30080
• Jaeger UI (APM) - http://localhost:16686
• Mailpit (Test email interface) - http://localhost:8025
• Payment Service - http://localhost:8001
• Tilt UI - http://localhost:10350

Development Features

Live Updates

The environment supports live code updates for:

• Frontend code changes
• GraphQL schema changes
• Payment service modifications

Resource Organization

Tilt UI organizes resources into sections:

1. Namespace: Kubernetes namespace setup
2. Backend: API, Database, Redis, etc.
3. Schema: GraphQL schema generation
4. Frontend: Storefront application
5. Services: Payment service
6. K8s: Kubernetes configurations

Troubleshooting

How to solve common issues?

1. Check service status

tilt status

2. View service logs

tilt logs <service-name>

3. Restart a service

tilt trigger <service-name>

4. Reset everything

tilt down && tilt up

Issues with API or Schema Generation

If the schema generation fails:

1. Check API logs: tilt logs api
2. Ensure API is running: curl http://localhost:8000/graphql/
3. Manually trigger schema generation: tilt trigger generate-schema

Database Issues

For database problems:

1. Check DB logs: tilt logs db
2. Restart migrations: tilt trigger apply-migrations
3. Reset sample data: tilt trigger populate-db

Feedback

If you have any questions or feedback, do not hesitate to contact us via:

• GitHub Discussions
• Discord Community - Join our community for quick help and discussions!

License

Disclaimer: Everything you see here is open and free to use as long as you comply with the license. There are no hidden charges. We promise to do our best to fix bugs and improve the code.

Crafted with ❤️ by Saleor Commerce

Project Structure

.
├── backend/           # Backend services
├── frontend/          # Storefront application
├── service/          # Additional services (payment, etc.)
├── k8s/              # Kubernetes configurations
└── Tiltfile         # Tilt configuration