Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexanderprod/gatsby-shopify-starter
🛍 Simple starter to build a blazing fast Shopify store with Gatsby.
https://github.com/alexanderprod/gatsby-shopify-starter
ecommerce gatsby-site gatsby-starter gatsby-starter-kit gatsbyjs react reactjs shopify storefront-api
Last synced: about 1 month ago
JSON representation
🛍 Simple starter to build a blazing fast Shopify store with Gatsby.
- Host: GitHub
- URL: https://github.com/alexanderprod/gatsby-shopify-starter
- Owner: AlexanderProd
- License: other
- Created: 2019-01-27T18:10:50.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T03:10:35.000Z (over 1 year ago)
- Last Synced: 2024-10-10T13:04:36.505Z (about 1 month ago)
- Topics: ecommerce, gatsby-site, gatsby-starter, gatsby-starter-kit, gatsbyjs, react, reactjs, shopify, storefront-api
- Language: JavaScript
- Homepage: https://gatsby-shopify-starter.alexanderhoerl.de
- Size: 3.36 MB
- Stars: 422
- Watchers: 15
- Forks: 95
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Gatsby Shopify starter
[](https://github.com/AlexanderProd/jam-stack-box)
Kick off your next eCommerce experience with this Gatsby starter. It is based on the default Gatsby starter to be easily modifiable. [Demo](https://gatsby-shopify-starter.alexanderhoerl.de)
Unfortunately Shopify prohibits to share access tokens in public repositories, therefore you have to to create your own Shopify Shop and put those credentials in the `template.env` file and rename it to `.env.development` as well as `.env.production`. There are two files if you want to use a different store for you development.
To obtain your own credentials you need the create a custom app in the Shopify frontend and enable the Storefront as well as the Admin API.
If you have questions feel free to message me on [Twitter](https://twitter.com/alexanderhorl) 🤙🏻
Checkout [nureineburg.alexanderhoerl.de](https://nureineburg.alexanderhoerl.de) for a real public shop built with this starter, the code is also [public](https://github.com/AlexanderProd/nureineburg.de/).
## 💎 Features
- Cart
- Product grid
- Product page
- Dynamic Inventory Checking
- Image optimization with Gatsby Image
- Styled Components with Emotion
- Google Analytics
- SEO
### 📦 Dynamic Inventory Checking
The Shopify product inventory is being checked in realtime, therefore no rebuilding and redeploy is needed when a product goes out of stock. This avoids problems where products could still be available even though they're out of stock due to redeploy delay.
### 🖌 Styling
I'm using [Emotion](https://emotion.sh/docs/introduction) as styled components library, but the starter is purposely only sparsely styled so you don't have to remove unecessary code but can instead add your own styling immediately.
## ⚠️ Common problems
- You need to use the Shopify Storefront API credentials not the regular Shopify API.
- You need to have at least one published product on Shopify.
## 🚀 Quick start
1. **Create a Gatsby site.**
Use the Gatsby CLI to create a new site, specifying this starter.
```sh
# create a new Gatsby site using this starter
gatsby new my-shopify-store https://github.com/AlexanderProd/gatsby-shopify-starter
```
1. **Start developing.**
Navigate into your new site’s directory and start it up.
```sh
cd my-shopify-store/
gatsby develop
```
1. **Open the source code and start editing!**
Your site is now running at `http://localhost:8000`!
_Note: You'll also see a second link: _`http://localhost:8000/___graphql`_. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the [Gatsby tutorial](https://www.gatsbyjs.org/tutorial/part-five/#introducing-graphiql)._
Open the `my-shopify-store` directory in your code editor of choice and edit `src/pages/index.js`. Save your changes and the browser will update in real time!
1. **Connect your own Shopify store.**
Open both `.env` files located in the root directory of your page end replace the credentials with your own. Don't forget to restart Gatsby for your store to be loaded!
⚠️ Make sure to use the Shopify storefront API credentials, not the regular Shopify API!
## Deploy
Checkout my other open-source project [JAMStackBox](https://github.com/AlexanderProd/jam-stack-box) to continuously deploy your Gatsby site on your own server.
## 🎓 Learning Gatsby
Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:
- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
- **To dive straight into code samples, head [to our documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.
## 📌 ToDo
I'll happily merge any pull request to improve the starter. 🙂
- [x] Convert Layout to function component.
- [x] Add dynamic inventory checking to avoid re-building after every purchase.
- [x] Add better styling.
- [x] Add image optimization using Gatsby sharp plugin.
- [x] Convert ProductForm to function component.