A GraphQL-powered, single-page dashboard application for Saleor.
See the public demo of Saleor Dashboard!
Or launch the demo on a free Heroku instance.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Node.js 10.0+
- A running instance of Saleor.
Clone the repository:
$ git clone https://github.com/mirumee/saleor-dashboard.git
Enter the project directory:
$ cd saleor-dashboard
To use the official stable release, checkout to a release tag:
$ git checkout 2.11.0
See the list of all releases here: https://github.com/mirumee/saleor-dashboard/releases/
If you want to use the latest development version, checkout to the master
branch:
$ git checkout master
Install NPM dependencies:
$ npm i
There are two environment variables available for configuration:
-
API_URI
(required) - URI of a running instance of Saleor GraphQL API. If you are running Saleor locally with the default settings, setAPI_URI
to:http://localhost:8000/graphql/
. -
APP_MOUNT_URI
- URI at which the Dashboard app will be mounted. E.g. if you setAPP_MOUNT_URI
to/dashboard/
, your app will be mounted athttp://localhost:9000/dashboard/
. -
STATIC_URL
- URL where the static files are located. E.g. if you use S3 bucket, you should set it to the bucket's URL. By default Saleor assumes you serve static files from the root of your site athttp://localhost:9000/
.
To start the development server run:
$ npm start
To build the application bundle run:
$ npm run build