Skip to content

wix/wix-headless-example

Repository files navigation

Wix Headless Examples

This Next.js project provides a minimal example site to demonstrate basic usage of various Wix Headless APIs. The implementation focuses on simplicity and readability, rather than feature richness, performance, or completeness. This repository can be used as a quick reference for bootstrapping a Wix Headless application, but it should not be treated as a best practices guide.

For a more comprehensive example of Wix Headless integration, we recommend checking out our starter templates.

You can view the latest version of this repo deployed at https://wix-headless-example.vercel.app/, but we recommend cloning it and experimenting with it locally.

Getting Started

First, run the development server:

yarn
yarn dev

Open http://localhost:3000 in your browser to see the result.

The following files demonstrate the usage of various Wix Headless APIs:

Package dependency management

To ensure this repo always uses the latest APIs from the Wix JavaScript SDK, the repo is preconfigured with Dependabot, GitHub's automated dependency management system. Due to the numerous pull requests generated by Dependabot, the repo also includes a preconfigured GitHub Action called "Combine PRs." This action can be executed manually to merge all of Dependabot's pull requests into a single PR, allowing for sanity checks to be performed only once. If the sanity check fails, each Dependabot PR can be inspected individually.