Getting Started

So you have a brand new Saleor API up and running, and would like to hook it up with Alt Storefront. Note that Alt Storefront currently supports version 2.11 of the Saleor core. Support for new Saleor core versions will be added after major releases. With that out of the way, let's get started!

First, you need to clone the Alt Storefront project. At a minimum, the following environment variables should be set. You may create a .env.local file in the root of the project for your local development convenience. Feel free to change the values depending on your needs.

# used for informing the browser to preconnect to your Saleor API's URL
ENDPOINT_ORIGIN=http://localhost:8000/
# your Saleor API's graphql URL
ENDPOINT=http://localhost:8000/graphql/
SITE_NAME=Alt Storefront
SITE_DESCRIPTION=An alternate storefront for the saleor ecommerce platform

Run yarn or yarn install to download the project dependencies. Run yarn start to run the project on your local machine. You can find more commands in the scripts section of the package.json file. Note that Yarn is the recommended package manager, as a yarn.lock file is included in the repository. This will ensure you have the exact same versions of dependencies as we do.

To customize the default port used when running the project locally, set the following environment variables.

PORT=3000
UMI_UI_PORT=3005

More configuration options are covered in the Configuration page.

Docker (Optional)

A Dockerfile and docker-compose.yml are included. Your standard Docker commands should work.