Saleor Storefront
Note: This project is beta quality. We don't advise using it in production.
A GraphQL-powered, PWA, single-page application storefront for Saleor.
Features
- Headless ecommerce storefront built with GraphQL, Apollo Client, React and Typescript
- Offline mode (beta)
- Saleor GraphQL API integration
- Single-page application experience
- Braintree Payment Gateway integration
Demo
See the public demo of Saleor Storefront!
Or launch the demo on a free Heroku instance. Note that you have to set the BACKEND_URL
environment to point to the Saleor instance.
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Prerequisites
-
Node.js 10.0+
-
A running instance of Saleor.
To run the storefront, you have to set the
BACKEND_URL
environment to point to the Saleor instance. If you are running Saleor locally with the default settings, setBACKEND_URL
to:http://localhost:8000/
.
Installing
Clone the repository:
git clone git@github.com:mirumee/saleor-storefront.git
Enter the project directory:
cd saleor-storefront
Install NPM dependencies:
npm i
Run the development server:
npm start
Go to http://localhost:3000
to access the storefront.
Translating
Add a new language pack file:
npm run add-locale <locale>
Update the list of available languages in the ./src/languages.ts
file.
Extract messages from source files that need to be translated:
npm run extract
Compile messages:
npm run compile
License
This project is licensed under the BSD-3-Clause License - see the LICENSE file for details