Skip to content

Commit 0d6d989

Browse files
authored
Add sample instructions
1 parent af8e78d commit 0d6d989

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -590,6 +590,44 @@ We welcome code contributions, feature requests, and reporting of issues. Please
590590
see [guidelines and instructions](.github/CONTRIBUTING.md). See
591591
[Contributing](./CONTRIBUTING.md) for development contribution guidance.
592592

593+
#### Running the sample app
594+
595+
To run the sample app in this repo, first clone the repo and run the following commands at the root of the project directory.
596+
597+
#### Install NPM dependencies
598+
599+
```sh
600+
yarn
601+
```
602+
603+
#### Install Cocoapods
604+
605+
```sh
606+
yarn pod-install sample/ios
607+
```
608+
609+
#### Build the local module
610+
611+
```sh
612+
yarn module build
613+
```
614+
615+
#### Update the dotenv file
616+
617+
Replace the details in the `sample/.env.example` file and rename it to `sample/.env`
618+
619+
```
620+
# Storefront Details
621+
STOREFRONT_DOMAIN="YOUR_STORE.myshopify.com"
622+
STOREFRONT_ACCESS_TOKEN="YOUR_PUBLIC_STOREFRONT_ACCESS_TOKEN"
623+
```
624+
625+
#### Start the sample app
626+
627+
```sh
628+
yarn sample start
629+
```
630+
593631
### License
594632

595633
Shopify's Checkout Sheet Kit is provided under an [MIT License](LICENSE).

0 commit comments

Comments
 (0)