Skip to content

Commit

Permalink
Update: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Kazuki-tam committed Oct 13, 2023
1 parent 6eb062b commit 82ff5ef
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,12 @@ shopify-email-notification is a template repository for email notifications.
- Built in useful commands

## Requirements
- [Node v16 or higher](https://nodejs.org/en/)
- [Node v18 or higher](https://nodejs.org/en/)
- [Shopify store](https://shopify.dev/themes/tools/development-stores#create-a-development-store-for-a-client)

## Main dependencies

- [Yarn](https://yarnpkg.com/)
- [pnpm](https://pnpm.io/ja/)
- [TypeScript](https://www.typescriptlang.org/)
- [Express](https://expressjs.com/)
- [LiquidJS](https://liquidjs.com/index.html)
Expand All @@ -39,7 +39,7 @@ shopify-email-notification is a template repository for email notifications.
Clone this repository and install dependencies.

```bash
yarn install
pnpm install
```

### Create a .env file
Expand Down Expand Up @@ -70,101 +70,101 @@ Recommend you to check out these commands before you get started.
Start your project in development mode.

```bash
yarn start
pnpm start
```

### Admin command

Open Shopify admin.

```bash
yarn admin
pnpm admin
```

### Orders command

Open order notification pages.

```bash
yarn orders
pnpm orders
```

### Shipping command

Open shipping notification pages.

```bash
yarn shipping
pnpm shipping
```

### Local delivery command

Open local delivery notification pages.

```bash
yarn localDelivery
pnpm localDelivery
```

### Local pickup command

Open local pickup notification pages.

```bash
yarn localPickup
pnpm localPickup
```

### Customer command

Open customer notification pages.

```bash
yarn customer
pnpm customer
```

### Email marketing command

Open email marketing notification pages.

```bash
yarn emailMarketing
pnpm emailMarketing
```

### Returns command

Open returns notification pages.

```bash
yarn returns
pnpm returns
```

### Format command

Format this project code.

```bash
yarn format
pnpm format
```

### Lint command

Lint this project code.

```bash
yarn lint
pnpm lint
```

Fix this project code.

```bash
yarn lint:fix
pnpm lint:fix
```

### PostInstall command

Install missing TypeScript typings.

```bash
yarn postInstall
pnpm postInstall
```

</details>
Expand Down

0 comments on commit 82ff5ef

Please sign in to comment.