Nuxt Commerce

A high-performance, server-rendered E-commerce app built with Nuxt & Shopify (Demo).

This template uses Nuxt UI, Image & Scripts optimization, Hybrid Rendering, SEO and more.

Nuxt Commerce comes with several useful features out of the box:

1. Nuxt UI - A UI Library for Modern Web Apps.
2. GraphQL Client - Minimal GraphQL Client + Code Generation
3. Image Optimization - Resize and transform your images using built-in optimizer or your favorite images CDN
4. Scripts - Load third-party scripts with better performance, privacy, security and DX
5. Hybrid rendering - Set different caching rules and rendering modes per route using Route Rules
6. SEO - Simple configuration for Sitemap.xml, Robots.txt, Meta, and OG Images
7. JSON-LD - Lightweight Linked Data format for products

Start here

You will need to use the environment variables defined in .env.example to run Nuxt Commerce.

Note: You should not commit your .env file or it will expose secrets that will allow others to control your Shopify store.

1
pnpm install
2
copy .env.example .env
3
pnpm run dev

Your app should now be running on localhost:3000.

You can also inspect production build like so:

1
pnpm run build
2
pnpm run preview

Integrations

If you wish to add an integration with 3rd Party service like Content Management System, Search Engine, or Payment Provider, you can do so by using the regular Nuxt module approach.

Create a new folder in the modules directory named as your integration (i.e storyblok) and inside of it, and index.ts file.

Normally, you could just install the modules and plugins directly inside the global nuxt.config.ts but as your application grows, it could become much harder to maintain the project. By following the modules approach defined by Nuxt you can easily extract domain code into separate module that wraps components, composables, types, and overall integration configuration

Adding a new integration

If your integration already has a Nuxt module existing, you can import it like shown below. In this file, you can also add integration specific code like components, composables, pages, and enable auto import for them.

1
// modules/storyblok/index.ts
2

3
export default defineNuxtModule({
4
  meta: {
5
    name: 'storyblok',
6
  },
7
  async setup() {
8
    const { resolve } = createResolver(import.meta.url)
9
    addComponentsDir({
10
      path: resolve('components'), // enable auto import for components/composables/types
11
    })
12

13
    await installModule('@storyblok/nuxt', {
14
      accessToken: '<YOUR_API_KEY>',
15
      componentsDir: '~/components',
16
      // more configuration options
17
    })
18
  },
19
})

Check out the full integration example here

In case of funcionality that does not have a Nuxt module yet, instead of installModule function, you would need to write a custom plugin youself.

E-Commerce Platform

By default, Nuxt Commerce works with Shopify as the E-Commerce Platform but you can use different platforms as well such as Medusa. To do so, you would need to create a custom integration by following thse steps:

1. Create a new folder in modules directory
2. In this folder, create a new index.ts file where the e-commerce backend code will be.
3. In this file, write integration code by using following example:

1
// modules/medusa/index.ts
2

3
export default defineNuxtModule({
4
  meta: {
5
    name: "medusa",
6
  },
7
  async setup() {
8
    const { resolve } = createResolver(import.meta.url);
9
    addImportsDir(resolve("composables"));  // enable auto import for components/composables/types
10

11
    await installModule('@nuxtjs/medusa', {
12
      baseUrl: '<YOUR_BASE_URL>'
13
      // more configuration options
14
    })
15
  }
16
})

1. Create composable that will contain the logic to handle complex e-commerce logic that is specific for this e-commerce backend like useCart, useAuth, etc
2. Create types, GQL queries, components and utils that are e-commerce specific.
3. Remove shopify folder from your project
4. Adjust the application to the new types and logic
5. Have fun and enjoy your new e-commerce app!

Kudos

This project wouldn't be possible without a help of amazing people below:

1. Daniel Roe
2. Alex Lichter
3. Lucie Haberer
4. Julien Huang
5. Sebastien Chopin
6. Sarah Moriceu
7. Thorsten Seyschab
8. Alvaro Saburido
9. ScottyZen -> Check out WooNuxt 🚀
10. Rylan Harper -> Check out Nitrogen 🚀