README.md

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!

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, set BACKEND_URL to: http://localhost:8000/.

Installing

Clone the repository:

git clone [email protected]: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.

Note: Offline mode doesn't currently work on the development server (run with npm start), which is a known issue in sw-precache-webpack-plugin and will be fixed in future releases.

License

This project is licensed under the BSD-3-Clause License - see the LICENSE.md file for details

Crafted with ❤️ by Mirumee Software

[email protected]