Shopify NextJS App Example
An example app built with NextJS that can be setup and deployed to production in seconds on Vercel.
All the glory goes back to https://github.com/t-kelly/nextjs-shopify-app where I forked the project.
The original repo is no more maintained and is not up-to-date with both shopify api and shopify node api changes.
The app template in this repo is up-to-date, maintained, tested and working! Enjoy!
Why use this app template instead of the Shopify CLI official one?
- Shopify CLI is generating an app that does not work out of the box.
- App generated with shopify CLI is using old version of shopify node API and old version of all kind of dependencies (it still uses the koa-shopify-node-api dependency which is full of bug and being abandoned. Honest advice: stay away from this lib)
- App generated with shopify CLI is using NextJS custom server which means that you can not publish to Vercel. You can publish to Heroku only. More over why using custom server when we can avoid it?
- App generated with shopify CLI is extremely slow (due to ngrok and NextJS custom server, server side changes using the shopify official app take ages to reflect). Development experience is awful. While development speed using this app template is acceptable. Once the app is loaded, changes in both server side and client side are fast.
- This app template uses the latest dependencies version and work out of the box :muscle: :sunglasses:
Deploy your own
This examples uses Upstash (Serverless Redis Database) as its data storage. During deployment, you will be asked to connect with Upstash. The integration will help you create a free Redis database and link it to your Vercel project automatically.
You'll need to get a Shopify App API Key and API secret key inside the Partner Dashboard to complete the deploy. After deployed, select App Setup on your app's summary page in Partner Dashboard, and update the following values:
- App Url:
- Redirection URLs:
Finally, install your app on a development store by selecting Test on development store on your app's summary page in Partner Dashboard
Setup Local Development
- Clone your app's repo
git clone https://github.com/[your-user-name]/nextjs-shopify-app.git
- Create another Shopify App for Development inside the Partner Dashboard and use the Shopify API Key and API secret key for local development.
.env.localand fill in values
npm installand then
npm run dev
- Expose your dev environment with ngrok (nextjs runs on port 3000 by default). I use:
ngrok http 3000 -region eu # # use the region near to you to speed up things when developping. # ngrok by @inconshreveable (Ctrl+C to quit) Session Status online Account email@example.com (Plan: Free) Version 2.3.40 Region Europe (eu) Web Interface http://127.0.0.1:4040 Forwarding http://yourNgrokTunnel.ngrok.io -> http://localhost:3000 Forwarding https://yourNgrokTunnel.ngrok.io -> http://localhost:3000
- Update your Dev Apps settings in the Partner Dashboard with the following URLs:
- Instead of using
https://yourNgrokTunnel.ngrok.io/for the App URL, use
- Instead of using
https://yourNgrokTunnel.ngrok.io/auth/callbackfor the Redirection URLs, use
You can start editing the page by modifying
pages/embedded/index.js. The page auto-updates as you edit the file.
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
Deploy on Vercel
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.
Support the project
- Improve the code base, answer issues and do pull requests
- Support by Bitcoin: 3Hi2ZYHTmFnH2pL6CCnif8ZMMt5RmizMRk
- Support by PayPal: https://paypal.me/redochka