Skip to content

Latest commit

 

History

History
48 lines (40 loc) · 1.83 KB

README.md

File metadata and controls

48 lines (40 loc) · 1.83 KB

Shopify App Boilerplate

This repository serves as a boilerplate for creating Shopify apps quickly using Remix, TypeScript, Tailwind CSS, Remix Flat Router and NodeMailer. It's designed to help streamline the development process by providing a pre-made code structure that can be reused for multiple apps.

Purpose

This boilerplate was created to speed up my development workflow for building Shopify apps. If you find it useful, feel free to use it for your own projects.

Features

  • Remix: A framework for building better React applications.
  • TypeScript: A strongly typed programming language that builds on JavaScript.
  • Tailwind CSS: A utility-first CSS framework for rapid UI development.
  • NodeMailer: A powerful tool to send emails from your Node.js apps.
  • Shopify Integration: Pre-configured to work with Shopify's API and authentication.
  • Modular Structure: Easily adaptable for different app functionalities.
  • Remix Flat Router: Utilizes the flat router structure of Remix for better routing.

Getting Started

Prerequisites

Ensure you have the following installed: + Node.js + npm or yarn + Shopify CLI

Installation

  git clone https://github.com/TheGreatSimo/shopify-app-boilerplate
  cd shopify-app-boilerplate

Set up your environment variables:

  • Create a .env file in the root directory.
  • Add your Shopify API key and secret:
SHOPIFY_API_KEY=your_api_key
SHOPIFY_API_SECRET=your_api_secret

Run the development server:

shopify app dev

Usage

This boilerplate includes basic setup for creating Shopify apps. You can modify and extend it to suit your needs.

Contributing

While this repository is primarily for personal use, contributions are welcome. Feel free to fork the repo and submit pull requests.

License

This project is licensed under the MIT License.