Skip to content

sammwyy/shopify-storefront

Repository files navigation

Shopify Storefront

Wrapper for the Shopify's Storefront API.

💻 Getting started

# With npm:
npm install shopify-storefront

# With yarn:
yarn add shopify-storefront

📚 Usage

As a ES Module

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

// 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
    • createCheckout
  • [] Products
    • product
    • products
  • [] Shop
    • shop

🤝 Contributing

Contributions, issues and feature requests are welcome! Feel free to check issues page.

❤️ Show your support

Give a ⭐️ if this project helped you!

Or buy me a coffeelatte 🙌🏾

Ko-fi | Patreon

📝 License

Copyright © 2022 Sammwy.
This project is MIT licensed.