Shopify Node App Starter
A Shopify embedded app starter template, written in TypeScript with session storage, app context and examples for basic functionalities.
Overview
The Shopify App Template is an opinionated starter template for creating embedded Shopify apps. It promotes the use of TypeScript and Next.js for building the app. It leverages middleware and Next.js APIs for OAuth, eliminating the need for a custom server. The template provides various features such as app subscriptions, session storage with Redis, Ngrok for development, webhook registration and persistence, and ready-to-use online and offline access tokens. It also includes examples and setups for request verification, route propagation, and loading screens while the app context is initializing. The template ensures type safety through GraphQL Code Generator for the Shopify Admin API and tRPC for end-to-end typesafe APIs.
Features
- TypeScript: Utilizes TypeScript for improved code reliability and maintainability.
- Next.js - React Framework for static rendering: Harnesses the power of Next.js for server-side rendering and static site generation.
- Serverless Architecture: Follows a serverless architecture, eliminating the need for a custom server setup.
- App Subscriptions: Provides functionality to create and manage app subscriptions.
- Session Storage with Redis: Implements session storage using Redis for efficient and secure data management.
- Ngrok for development: Uses Ngrok to create a secure tunnel for local development and testing.
- Webhook registration and persistence after server restart: Handles webhook registration and ensures persistence even after server restarts.
- Ready to use online and offline access tokens simultaneously: Allows usage of both online and offline access tokens for seamless integration with Shopify APIs.
- App context set up: Sets up the app context, enabling the storage of data required in multiple places.
- Request verification set up: Implements request verification to ensure authentication and secure API calls.
- Link component for relative paths: Provides a custom Link component to convert <a> tags to Next Links for relative paths.
- Route propagation set up: Sets up route propagation to enable smooth navigation and app flow.
- Examples for creating and displaying app subscriptions: Includes examples and implementations for creating and displaying app subscriptions.
- Loading screen while app context is initializing: Displays a loading screen to enhance user experience while the app context is initializing.
- Typesafety with GraphQL Code Generator for the Shopify Admin API: Ensures type safety by generating GraphQL schemas for the Shopify Admin API.
- tRPC for end-to-end typesafe APIs: Implements tRPC for end-to-end type safe APIs.
- Next.js
Next.js is a React-based web framework that enables server-side rendering, static site generation, and other powerful features for building modern web applications.
- React
React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components
- Shopify
Shopify offers headless commerce capabilities through its Storefront API, allowing developers to use their own front-end technology to create custom storefronts or sales channels while using Shopify as a back-end system
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Graphql
A website that uses GraphQL as a query language to manage data fetching and state management. This includes features such as a strongly typed schema, client-side caching, and declarative data fetching to streamline data management and optimize website performance.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.
