Skip to content

About

A GraphQL-powered, single-page dashboard application for Saleor.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1.0k stars

Watchers

29 watching

Forks

Latest commit

 

History

5,421 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Saleor Dashboard 25/26

Saleor Dashboard

A GraphQL-powered, single-page dashboard application for Saleor.

Get to know Saleor:
Talk to a human | Talk to the API

Prerequisites

  • Node.js v24
  • A running instance of Saleor
  • PNPM package manager - preferably installed via corepack
  • Docker, to run the E2E suite (it starts its own Saleor)

Development

  1. Clone the repository:
git clone https://github.com/saleor/saleor-dashboard.git
  1. Enter the project directory:
cd saleor-dashboard
  1. Install the dependencies:
pnpm install
  1. Configure the env vars as described in docs/configuration.md.

  2. 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.

Testing

Unit and component tests need nothing running:

pnpm test                         # everything
pnpm run test:quiet <file_path>   # one file

The E2E suite brings up its own Saleor in Docker, seeds it, builds the dashboard from your working tree and drives it in a browser — no Saleor Cloud, no credentials, nothing to configure:

pnpm e2e         # against the latest stable Saleor (3.23)
pnpm e2e:main    # against Saleor's unreleased main branch
pnpm e2e:all     # both
pnpm e2e --ui    # ...and anything else Playwright understands
pnpm e2e:fresh   # start over from an empty database
pnpm e2e:down    # stop the stacks when you are done

The dashboard supports both Saleor generations at once, and which one a build speaks to is decided at build time, so each target is a separate Saleor and a separate bundle. The first run pulls an image, migrates and seeds — a few minutes; afterwards a run reaches the first test in seconds. The database is restored before every test, so a failing test reproduces on its own.

See e2e/README.md for the seeds, the actors and how to port a spec.

Note: e2e-legacy/ is the previous suite, which runs against a provisioned Saleor Cloud instance (pnpm run e2e:legacy). It is frozen — new tests belong in e2e/.

Docs

About

A GraphQL-powered, single-page dashboard application for Saleor.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1.0k stars

Watchers

29 watching

Forks

Releases

Packages

Used by

Contributors

Languages