shopify-email-notification

shopify-email-notification is a template repository for email notifications. This template makes it easy to customize notification files at local.

Status

Features

• Previewing notification mails at local server
• Hot reloading of local server
• Referring to default email templates which Shopify provides
• Based on Liquid templates
• Editable notification variables
• TypeScript support
• Multi language support (English and Japanese)
• Built in useful commands

Requirements

• Node v18 or higher
• Shopify store

Main dependencies

• pnpm
• TypeScript
• Express
• LiquidJS
• ESLint
• Prettier
• Jest

How to use

Clone this repository and install dependencies.

pnpm install

Create a .env file

Create a .env at the root, and then add your shopify admin url. Replace your-shop-name with yours.

ADMIN_URL=https://your-shop-name.myshopify.com/admin/

Start your project in development mode.

pnpm start

Open http://localhost:4000, and then you can preview notification templates.

Command list

Recommend you to check out these commands before you get started.

Support commands

Start command

Start your project in development mode.

pnpm start

Admin command

Open Shopify admin.

pnpm admin

Orders command

Open order notification pages.

pnpm orders

Shipping command

Open shipping notification pages.

pnpm shipping

Local delivery command

Open local delivery notification pages.

pnpm localDelivery

Local pickup command

Open local pickup notification pages.

pnpm localPickup

Customer command

Open customer notification pages.

pnpm customer

Email marketing command

Open email marketing notification pages.

pnpm emailMarketing

Returns command

Open returns notification pages.

pnpm returns

Format command

Format this project code.

pnpm format

Lint command

Lint this project code.

pnpm lint

Fix this project code.

pnpm lint:fix

PostInstall command

Install missing TypeScript typings.

pnpm postInstall

Liquid templates

You'll find notification templates in views directories.

• en folder: English templates
• ja folder: Japanese templates

Notification variables

Edit emailEnv.ts if you want to modify the value of notification variables.

server/constants/emailEnv.ts

Contributes

Pull requests are always welcome.

License

MIT