Prerequisites

• Node.js v24
• A running instance of Saleor
• PNPM package manager - preferably installed via corepack

Development

1. Clone the repository:

git clone https://github.com/saleor/saleor-dashboard.git

2. Enter the project directory:

cd saleor-dashboard

3. Install the dependencies:

pnpm install

4. Configure the env vars as described in docs/configuration.md.

5. Start the development server with:

pnpm run dev

Note: If you see CORS errors, check CORS configuration of your Saleor instance or CORS settings in the Cloud Console.

Named URLs with portless (optional)

portless serves the dev server on a stable https://dashboard.localhost instead of http://localhost:9000. Useful when you run several checkouts or worktrees at once — each one gets its own URL instead of fighting over port 9000.

The repo is already configured (portless.json), but portless itself is not a dependency — install it globally:

npm install -g portless

Then, instead of pnpm run dev:

portless

The first run asks for your password once, to bind port 443 and trust a local CA. It runs the dev script and prints the URL. In a git worktree the branch name is prepended, e.g. https://my-branch.dashboard.localhost.

pnpm run dev keeps working as before — portless is opt-in.

Docs

• Configuration ⚙️
• Error tracking ⚠️
• Running tests 🏁
• Usage with Docker 🐳
• Sentry adapter 🗼
• Deployment 🌐
• Developing with stable and staging Saleor graphql.schema