Vendure Storefront Data Hooks

UI hooks and data fetching methods built from the ground up for e-commerce applications written in React, that use Vendure as a headless e-commerce platform.

Usage

1. Choose a Vendure server

For the fastest start, you can point to the live Vendure demo server which runs at https://demo.vendure.io. This lets you work with the Vendure data hooks without needing to set up a local server.

If you want to have more control over the server, then getting up an running with a local server is only slightly more work:

1a. Running a local Vendure server

Install Vendure locally with one command:
```
npx @vendure/create my-app
```
(See the Vendure getting started guide for more info).

Once you have Vendure set up, change the default port to something other than 3000, to avoid conflict with your Next.js Commerce dev server:

// my-app/src/vendure-config.ts
export const config: VendureConfig = {
    apiOptions: {
        port: 3001,  // <----- here
        adminApiPath: 'admin-api',
        // ...
    }
};

Start your local Vendure server
```
yarn start
```

2. Set up the Commerce storefront

Clone this repo and install its dependencies with yarn install or npm install

Change the paths in tsconfig.json to point to the Vendure hooks:

-  "@framework/*": ["framework/bigcommerce/*"],
-  "@framework": ["framework/bigcommerce"]
+  "@framework/*": ["framework/vendure/*"],
+  "@framework": ["framework/vendure"]

Set the Vendure Shop API URL in your .env.local file:

NEXT_PUBLIC_VENDURE_SHOP_API_URL=http://localhost:3001/shop-api

or if using the live demo server:

NEXT_PUBLIC_VENDURE_SHOP_API_URL=https://demo.vendure.io/shop-api

Add the server domain to the images property next.config.js file as per the image optimization docs

module.exports = {
  // ...
  images: {
    domains: [
      'localhost',
      // or
      'demo.vendure.io',
    ],
  },
}

With the Vendure server running, start this project using yarn dev or npm run dev.

Known Limitations

Vendure does not ship with built-in wishlist functionality.
Nor does it come with any kind of blog/page-building feature. Both of these can be created as Vendure plugins, however.
The entire Vendure customer flow is carried out via its GraphQL API. This means that there is no external, pre-existing checkout flow. The checkout flow must be created as part of the Next.js app. See https://github.com/vercel/commerce/issues/64 for further discusion.
By default, the sign-up flow in Vendure uses email verification. This means that using the existing "sign up" flow from this project will not grant a new user the ability to authenticate, since the new account must first be verified. Again, the necessary parts to support this flow can be created as part of the Next.js app.

Code generation

This provider makes use of GraphQL code generation. The schema.graphql and schema.d.ts files contain the generated types & schema introspection results.

When developing the provider, changes to any GraphQL operations should be followed by re-generation of the types and schema files:

From the project root dir, run

graphql-codegen --config ./framework/vendure/codegen.json

3.6 KiB Raw Blame History