Giter Club home page Giter Club logo

nuxtshop's Introduction

NuxtShop

Introduction

NuxtShop is a highly-customizable, open-source starter kit, introduced at Vue.js Nation 2022, for building headless Shopify stores with Nuxt 3. It comes out of the box with a great developer experience and in-built performance practices as a foundation for a production-quality eCommerce site.

Read the blog post NuxtShop: A Nuxt and Shopify eCommerce Starter Kit to learn more.

Technologies

NuxtShop uses the following technologies:

Features/Benefits

  • Easy to setup/get started.
  • Only necessary packages required to run.
  • Customizable โ€” minimal styling out of the box.
  • Cart.
  • Shopify checkout.
  • 1-click deploy to Layer0 with features like Real User Monitoring

1-click deploy to Layer0

Click the deploy button below to deploy NuxtShop to Layer0 in 1-click.

Deploy with Layer0

NOTE: If you're deploying to Layer0, Layer0 only supports Node.js version 14. See this guide on how to Install Node.js and npm


Getting Started

1. Fork and clone this repository

Fork this repository to your GitHub account and then clone it to your local environment.

2. Install dependencies

Install the dependencies:

yarn install

3. Local development

Start the development server on http://localhost:3000:

yarn dev

4. Production

Build the application for production:

yarn build

Checkout the deployment documentation.


Shopify Setup

App Setup

  • rename .env.sample to .env
  • Add your Shopify Access Token and *.myshopify url to the .env variables

Dev tooling recommendations


Limitations

Because NuxtShop is built in the open and on the bleeding-edge, there are a few limitations to be aware of:

  1. NuxtShop is built on Nuxt3 which at this time is still officially in beta
  2. NuxtShop uses the new Shopify Cart API which does not support Shopify Scripts on Plus yet. To use scripts, you can adjust to the Checkout API

Troubleshoot

Deploying to Layer0? Node 14 is the latest supported version.


Recommended resources

  1. Nuxt3 official documentation

nuxtshop's People

Contributors

justinmetros avatar adebiyial avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.