An open API service indexing awesome lists of open source software.

https://github.com/zeon-studio/commerceplate

Shopify Storefront Boilerplate Using Nextjs and Tailwindcss
https://github.com/zeon-studio/commerceplate

boilerplate ecommerce nextjs shopify starter-template storefront-api tailwindcss

Last synced: 8 months ago
JSON representation

Shopify Storefront Boilerplate Using Nextjs and Tailwindcss

Awesome Lists containing this project

README

          

Commerceplate | NextJs + Shopify + Tailwind CSS + TypeScript Starter and Boilerplate

A free, production-ready Next.js template powered by Tailwind CSS and TypeScript, specifically designed for Shopify. Utilizes the Shopify Storefront API through GraphQL and providing everything you need to jumpstart your Next project and save valuable time.

Made with โ™ฅ by Zeon Studio


If you find this project useful, please give it a โญ to show your support.

๐Ÿ‘€ Demo | Page Speed (97%)๐Ÿš€




license

code size


contributors

## ๐Ÿ“Œ Key Features

- ๐ŸŒ Dynamic Products from Shopify Storefront API
- ๐Ÿ’ธ Checkout and Payments with Shopify
- ๐ŸŒž Automatic Light/Dark Mode
- ๐Ÿš€ Fetching and Caching Paradigms
- ๐Ÿ”— Server Actions for Mutations
- ๐Ÿ” User Authentication
- ๐Ÿงฉ Similar Products Suggestions
- ๐Ÿ” Search, Sort, Different Views Functionality
- ๐Ÿท๏ธ Tags & Categories & Vendors & Price Range & Product Variants Functionality
- ๐Ÿ–ผ๏ธ Single Product Image Zoom, Hover Effect, Slider
- ๐Ÿ›’ Cart & Easy editing options for cart items
- ๐Ÿ“ Product Description on Multiple Tabs
- ๐Ÿ”— Netlify Setting Pre-configured
- ๐Ÿ“ž Support Contact Form
- ๐Ÿ“ฑ Fully Responsive
- ๐Ÿ”„ Dynamic Home Banner Slider
- ๐Ÿ“ Write and Update Content in Markdown / MDX
- โŒ› Infinite Product Load on Scrolling

### ๐Ÿ“„ 10+ Pre-designed Pages

- ๐Ÿ  Homepage
- ๐Ÿ‘ค About
- ๐Ÿ“ž Contact
- ๐Ÿ›๏ธ Products
- ๐Ÿ“ฆ Product Single
- ๐Ÿ’ก Terms of services
- ๐Ÿ“„ Privacy Policy
- ๐Ÿ” Login
- ๐Ÿ”‘ Register
- ๐Ÿšซ Custom 404

## ๐Ÿš€ Getting Started

### ๐Ÿ“ฆ Dependencies

- shopify
- next 15.3.0+
- node v20.10+
- npm v10.2+
- tailwind v4.1+

## ๐Ÿ›’ Retrieve Shopify Token & Add Demo Products

- To get the tokens needed, create a Shopify partner account.
![Screenshot_1](https://raw.githubusercontent.com/tfmurad/images-shopify-commerce/refs/heads/main/1.png)

- Now go to 'stores' and select 'Add store.' Create a development store using the option 'Create development store'.
![Screenshot_2](https://raw.githubusercontent.com/tfmurad/images-shopify-commerce/refs/heads/main/2.png)

- Click on import products.
![Screenshot_3](https://raw.githubusercontent.com/tfmurad/images-shopify-commerce/refs/heads/main/3.png)

- Locate the 'products' CSV file in the public folder of the repository and upload it for demo products.
![Screenshot_4](https://raw.githubusercontent.com/tfmurad/images-shopify-commerce/refs/heads/main/4.png)

- On the admin dashboard, click on โ€˜Settingsโ€™ at the bottom of the left sidebar.
![Screenshot_5](https://raw.githubusercontent.com/tfmurad/images-shopify-commerce/refs/heads/main/5.png)

- On the Settings page, click on โ€˜Apps and sales channelsโ€™ on the left sidebar.
![Screenshot_6](https://raw.githubusercontent.com/tfmurad/images-shopify-commerce/refs/heads/main/6.png)

- In the Apps and sales channels page that opens, click on โ€˜Develop appsโ€™ on the top right.
![Screenshot_7](https://raw.githubusercontent.com/tfmurad/images-shopify-commerce/refs/heads/main/7.png)

- Now, on the App development page that opens, click on โ€˜Create an appโ€™.
![Screenshot_8](https://raw.githubusercontent.com/tfmurad/images-shopify-commerce/refs/heads/main/8.png)

- A โ€˜Create an appโ€™ popup opens. Fill in any name in the โ€˜App Nameโ€™ text box. In the App Developer text box, your name and email id is automatically fetched. Else type in the same email id you used while signing up for the Shopify store.
![Screenshot_9](https://raw.githubusercontent.com/tfmurad/images-shopify-commerce/refs/heads/main/9.png)

- Next, click on โ€˜Configureโ€™ in the Storefront API integration section.
![Screenshot_10](https://raw.githubusercontent.com/tfmurad/images-shopify-commerce/refs/heads/main/10.png)

- In the Storefront API access scopes, select and check all the boxes and click on โ€˜Saveโ€™ and then โ€˜Install appโ€™.
![Screenshot_11](https://raw.githubusercontent.com/tfmurad/images-shopify-commerce/refs/heads/main/11.png)

- Navigate to the 'API credentials' tab and locate three essential pieces of information. Subsequently, update your `.env` file by replacing the placeholder quotes("") in the `.env.example` file with your Shopify credentials.
![Screenshot_12](https://raw.githubusercontent.com/tfmurad/images-shopify-commerce/refs/heads/main/12.png)

- When adding your product, use the same alt title for images with the same color. This helps the first image appear as the color variant in the selector.
![Screenshot_13](https://raw.githubusercontent.com/tfmurad/images-shopify-commerce/refs/heads/main/13.png)
![Screenshot_14](https://raw.githubusercontent.com/tfmurad/images-shopify-commerce/refs/heads/main/14.png)

- We have the option to create additional collections for products.
![Screenshot_15](https://raw.githubusercontent.com/tfmurad/images-shopify-commerce/refs/heads/main/15.png)

## ๐Ÿš€ Setting Up the Hero Slider

1. Go to the file `/src/config/config.json` in your Shopify project and find the 'hero_slider' section. Youโ€™ll see something like this:

```json
"shopify": {
"currencySymbol": "เงณ",
"currencyCode": "BDT",
"collections": {
"hero_slider": "hidden-homepage-carousel",
"featured_products": "featured-products"
}
}
```

2. Change the 'hero_slider' collection name to something of your choice.

3. Then, go to your Shopify Partner Dashboard, navigate to Products > Collections, and create a collection with the same name you set in the config file (e.g., 'hidden-homepage-carousel').

4. Add the products you want to display in the hero slider to this collection.

### ๐Ÿ‘‰ Install Dependencies

```bash
npm install
```

### ๐Ÿ‘‰ Development Command

```bash
npm run dev
```

### ๐Ÿ‘‰ Build Command

```bash
npm run build
```

## ๐Ÿž Reporting Issues

We use GitHub Issues as the official bug tracker for this Template. Please Search [existing issues](https://github.com/zeon-studio/commerceplate/issues). Itโ€™s possible someone has already reported the same problem.
If your problem or idea has not been addressed yet, feel free to [open a new issue](https://github.com/zeon-studio/commerceplate/issues).

## ๐Ÿ“ License

Copyright (c) 2023 - Present, Designed & Developed by [Zeon Studio](https://zeon.studio/)

**Code License:** Released under the [MIT](https://github.com/zeon-studio/commerceplate/blob/main/LICENSE) license.

**Image license:** The images are only for demonstration purposes. They have their license, we don't have permission to share those images.

## ๐Ÿ’ป Need Custom Development Services?

If you need a custom theme, theme customization, or complete website development services from scratch you can [Hire Us](https://zeon.studio/).