https://github.com/sammwyy/shopify-storefront

Wrapper for the Shopify's Storefront API.
https://github.com/sammwyy/shopify-storefront

graphql shopify shopify-api shopify-checkout shopify-graphql-api shopify-storefront

Last synced: 2 months ago
JSON representation

Wrapper for the Shopify's Storefront API.

• Host: GitHub
• URL: https://github.com/sammwyy/shopify-storefront
• Owner: sammwyy
• License: mit
• Created: 2022-12-19T02:48:29.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-20T04:50:52.000Z (about 2 years ago)
• Last Synced: 2024-11-13T05:04:23.247Z (2 months ago)
• Topics: graphql, shopify, shopify-api, shopify-checkout, shopify-graphql-api, shopify-storefront
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/shopify-storefront
• Size: 93.8 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Shopify Storefront

Wrapper for the Shopify's Storefront API.

## 💻 Getting started

```shell

# With npm:

npm install shopify-storefront

# With yarn:

yarn add shopify-storefront

```

## 📚 Usage

### As a ES Module

```javascript

import { ShopifyClient } from 'shopify-storefront';

// Initialize client.

const shopify = new ShopifyClient({

  accessToken: process.env['SHOPIFY_ACCESS_TOKEN'] as string,

  storeDomain: process.env['SHOPIFY_STORE_DOMAIN'] as string,

});

// Get shop data.

shopify.shop.getShop()

    .then(console.log);

```

### As CJS Module

```javascript

// If uses require function you will need to use .default

// For import in typescript, this is not required

const { ShopifyClient } = require('shopify-storefront').default;

```

## 📝 To Do

- [] Checkout

  - [x] createCheckout

- [] Products

  - [x] product

  - [x] products

- [] Shop

  - [x] shop

## 🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check [issues page](https://github.com/sammwyy/shopify-storefront/issues).

## ❤️ Show your support

Give a ⭐️ if this project helped you!

Or buy me a coffeelatte 🙌🏾

[Ko-fi](https://ko-fi.com/sammwy) | [Patreon](https://patreon.com/sammwy)

## 📝 License

Copyright © 2022 [Sammwy](https://github.com/sammwyy).  

This project is [MIT](LICENSE) licensed.