Skip to content

Installation

Let’s get you started ⚡️

Installation Guide

  1. Clone the Github repository

    Copy the Github url and run in your own terminal to clone the repository.

    Terminal window
    git clone https://github.com/Rapid-ui-com/headless-shopify-boilerplate.git
  2. Install the dependencies.

    Terminal window
    cd <your-repository-name>
    npm install
  3. Rename the .env.example to .env.local

  4. Start the development server Start the development server and open it in your browser at http://localhost:3000

    Terminal window
    npm run dev
    .env.local
    LIVE_PROJECT_PRODUCTION_URL=yourwebsite.com
    # -----------------------------------------------------------------------------
    # Shopify
    # -----------------------------------------------------------------------------
    SHOPIFY_STORE_URL=yourstore.myshopify.com
    SHOPIFY_STOREFRONT_CLIENT_ACCESS_TOKEN=
    SHOPIFY_NEWSLETTER_ACCESS_TOKEN=
    SHOPIFY_WEBHOOK=
    # -----------------------------------------------------------------------------
    # Email (Resend)
    # -----------------------------------------------------------------------------
    RESEND_API_KEY=
    # -----------------------------------------------------------------------------
    # Facebook (Tracking Pixel)
    # -----------------------------------------------------------------------------
    NEXT_PUBLIC_FACEBOOK_PIXEL_ID=
    FACEBOOK_ACCESS_TOKEN=