This is an app scaffold integrating Next.js with the Zendesk App Framework.

Getting Started

Prerequisite

Must have Zendesk App Tools installed. If needed, see these docs to get started.

1. Clone or fork this repo
2. cd into the app_local directory
3. Run yarn install or npm install

In order to run the app locally on your Zendesk instance, first run the development server for Next.js. You need to run the following command on the parent directory sample-zaf-next

cd..
npm run dev
# or
yarn dev

While you Next.js development server is running, run the following command to serve your app to your Zendesk instance.

zat server

Current location of this app is in the Top Bar. This can be changed in the manifest file.

You can start editing the page by modifying pages/index.js. You will need to import useZAFClient into any pages/components where requests/actions to the client will be made. The page auto-updates as you edit the file.

After deployment be sure to update the location url to where your app is hosted.

Happy Coding! 🥳