https://github.com/guyshilo/storefront
https://github.com/guyshilo/storefront
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/guyshilo/storefront
- Owner: guyShilo
- License: bsd-3-clause
- Created: 2020-02-03T07:11:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T12:48:42.000Z (over 3 years ago)
- Last Synced: 2025-01-22T01:28:58.606Z (over 1 year ago)
- Language: TypeScript
- Size: 24.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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](https://github.com/mirumee/saleor/).
## Features
- Headless ecommerce storefront built with [GraphQL](https://graphql.org/), [Apollo Client](https://www.apollographql.com/client), [React](https://reactjs.org/) and [Typescript](https://www.typescriptlang.org/)
- Offline mode (beta)
- Saleor GraphQL API integration
- Single-page application experience
- [Braintree Payment Gateway](https://www.braintreepayments.com/) integration
## Demo
See the [public demo](http://pwa.saleor.io) of Saleor Storefront!
Or launch the demo on a free Heroku instance.
[](https://heroku.com/deploy)
## 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 `API_URI` environment variable to point to the Saleor GraphQL API. If you are running Saleor locally with the default settings, set `API_URI` to: `http://localhost:8000/graphql/`.
### Installing
Clone the repository:
```
git clone https://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
```
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](https://github.com/mirumee/saleor-storefront/blob/master/LICENSE) file for details
#### Crafted with ❤️ by [Mirumee Software](http://mirumee.com)
hello@mirumee.com