URLs
Note: Instructions on how to fetch menuIds for a given API key are available in the "Multi-location support" section below.
Example menuId: 5ffd5ad4-d853-48cd-a19b-421490314676
Localhost:
- Juices Menu Board: http://localhost:3000/menu-boards/juices?menu={menuId}&footnote={footnote}
- Smoothies Menu Board: http://localhost:3000/menu-boards/smoothies?menu={menuId}&footnote={footnote}
Production:
- Juices Menu Board: https://wholefoods.vercel.app/menu-boards/juices?menu={menuId}&footnote={footnote}
- Smoothies Menu Board: https://wholefoods.vercel.app/menu-boards/smoothies?menu={menuId}&footnote={footnote}
- Node (version defined in
.nvmrc) - Yarn
.envfile populated with values listed in.env.sample
Start the development server
yarn devSee here for a comprehensive guide to building Raydiant apps.
There is one builder input for this project. Builder inputs can be configured after creating a new app in Raydiant's Developer portal
- Location (select input) - Corresponds to a menu ID
- Menu Board (select input) - Corresponds to a NextJS route
- Footnote (text input) - Corresponds to a query param
A couple of additional steps are required for multi-location/menu support.
- Using your API key, make a call to
/v1/menusto retrieve the list of menus your API key has access to
cURL example:
curl --location --request GET 'https://menu-api.raydiant.com/v1/menus' \
--header 'x-api-key: <API_KEY>'
- Take note of all the
menuIdsrequired for your digital menu - Go to the developer portal and select your app
- Creat a new "select" builder input
- Populate the "options" section with the aforementioned
menuIds - Confirm you can make an API request to fetch group data for a given menu/location
/v1/groups?tags=<tag>&menus=<menuId>depth=<depth>
CI/CD is setup to deploy our apps using the Vercel Platform
Check out our Next.js deployment documentation for more details.