> ## Documentation Index
> Fetch the complete documentation index at: https://codebeans-cb-notifylyst.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> From install to a working restock alert, following the setup guide on Home.

Home has a four-step setup guide. Follow it in order and, at the end, sold-out products on your
storefront collect sign-ups and alert shoppers when stock returns.

**1. Install Notifylyst and choose a plan**

Install from the Shopify App Store and approve the permissions. If your store has no plan yet, the
app shows **Choose a plan to get started** and takes you to Shopify's plan page. Pick a plan
(paid plans start with a free trial) and approve it — you land back on **Home**.

More on plans: [Change your plan](https://codebeans-cb-notifylyst.mintlify.site/app/guides/change-your-plan.md).

**2. Turn on Notifylyst in your theme**

The first step of the guide. Notifylyst is a theme app extension: nothing appears on your
storefront until you switch on its **app embed**, **Notifylyst Restock Widget**. It loads the
**Notify me** button and the sign-up form on every page.

Press **Open theme editor** in the step, open **App embeds**, switch on **Notifylyst Restock
Widget**, and **Save**. Back in the app, the guide checks your live theme and ticks the step — or
tells you **Still off in your theme. Switch it on and save.**

![The Shopify theme editor's App embeds panel with Notifylyst Restock Widget switched on.](https://mintcdn.com/codebeans-cb-notifylyst/helB_Y1ZQRw5r3Uo/images/app-03-theme-block.png?fit=max\&auto=format\&n=helB_Y1ZQRw5r3Uo\&q=85\&s=b2afcf21c19ca2a02b3039eb67ae2f9c)

**3. Show the Notify me button**

Choose how shoppers reach the form:

* **Turn on floating button** — a tab on the edge of every product page, shown only when the
  selected variant is sold out. Styled under **Appearance → Notify me button**.
* or add the **Notifylyst Restock Button** block to your product template, so the button sits
  next to **Add to cart**.

You can use both. Details: [Storefront widget](https://codebeans-cb-notifylyst.mintlify.site/app/setup/storefront-widget.md).

![The Setup steps card on Home at 4 of 4: Turn on Notifylyst in your theme (with Open theme editor), Show the Notify me button, Try it on a sold-out product and Send yourself a test alert.](https://mintcdn.com/codebeans-cb-notifylyst/helB_Y1ZQRw5r3Uo/images/app-02-home-setup.png?fit=max\&auto=format\&n=helB_Y1ZQRw5r3Uo\&q=85\&s=0ee516dfaa4bf295e9752a9ba1cb0919)

**4. Try it on a sold-out product**

Open a sold-out product on your storefront, choose the sold-out variant, and press **Notify me
when available**. Sign up with your own email address. Then press **It works** in the guide.

Your sign-up appears in **Analytics → Sign-ups** within moments — the fastest proof that
everything is connected.

![The Notify me when available form open on a sold-out product, with the variant picker, the channel tabs, the email field, the quantity and the Notify me button.](https://mintcdn.com/codebeans-cb-notifylyst/helB_Y1ZQRw5r3Uo/images/app-05-storefront-signup.png?fit=max\&auto=format\&n=helB_Y1ZQRw5r3Uo\&q=85\&s=559d6ea09de4c1c3995676289ef55a5c)

**5. Send yourself a test alert**

Press **Send test alert** to open **Appearance → Notifications**, then **Send test email**. You
get the exact message a shopper receives when the product is back.

Email is on from the start. Web push you switch on yourself; SMS needs a one-time activation
review — see [Notification channels](https://codebeans-cb-notifylyst.mintlify.site/app/setup/notification-channels.md).

![Settings → Channels with Email, Web push, SMS and WhatsApp and their on/off switches.](https://mintcdn.com/codebeans-cb-notifylyst/helB_Y1ZQRw5r3Uo/images/app-04-channels.png?fit=max\&auto=format\&n=helB_Y1ZQRw5r3Uo\&q=85\&s=e7201adf2b9ad0a3d68604a51944a69e)

> [!TIP]
>
> **That is the whole loop.** Home now says **You are all set**. Sign-ups collect against your
> products, and the moment stock comes back, everyone waiting is alerted.

## Worth doing in your first week

| Task | Why |
| - | - |
| [Choose your delivery rule](https://codebeans-cb-notifylyst.mintlify.site/app/setup/delivery-rules.md) | Decide whether a shopper who asked for 3 units is alerted when only 1 comes back. |
| [Read your default messages](https://codebeans-cb-notifylyst.mintlify.site/app/guides/message-templates.md) | They work as shipped, but the wording should sound like your brand. |
| [Style the button and form](https://codebeans-cb-notifylyst.mintlify.site/app/guides/customize-appearance.md) | Match your theme's colours and wording. |
| [Import an existing waiting list](https://codebeans-cb-notifylyst.mintlify.site/app/setup/import-signups.md) | If you have been collecting requests somewhere else, bring them in. |
| [Schedule a weekly summary](https://codebeans-cb-notifylyst.mintlify.site/app/guides/reports-and-alerts.md) | Then you never have to remember to open the app. |
| [Look at Most wanted](https://codebeans-cb-notifylyst.mintlify.site/app/guides/read-your-analytics.md) | Within days it becomes a restock list ranked by real demand. |

> [card] [Your first day, as a story](https://codebeans-cb-notifylyst.mintlify.site/journeys/merchant-first-day.md)
>
> The same steps, with what to check at each one.

> [card] [Set up](https://codebeans-cb-notifylyst.mintlify.site/app/setup/overview.md)
>
> Each setup task in full.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.