Shop Minis Examples

This repository showcases examples of Shop Minis.

About

Shop Minis are lightweight, mini apps that enable you to build rich shopping experiences inside Shop.

Getting Started

Prerequisites

To build Shop Minis, you’ll need:

• Node.js version 20 or higher
• Xcode or Android Studio
• A code editor such as Cursor or VSCode

Installation

1. Clone the repository:

   git clone https://github.com/Shopify/shop-minis-examples.git
   cd shop-minis-examples

2. Go to the Mini you would like to explore. For example:

   cd all-hooks

3. Install dependencies:

   npm install

4. Run the example:

   npx shop-minis dev

Contributing

We welcome contributions! Please see our Contributing Guide for details on how to get started.

Before contributing, please read our Code of Conduct.

Support

If you encounter any issues or have questions, please:

1. Check the existing issues in the repository
2. Create a new issue if your problem hasn't been reported
3. Reach out to the maintainers

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

Thank you to all contributors who help make Shop Minis better!

---

Copyright 2024-present, Shopify Inc.