Skip to content

Commit 126ab4b

Browse files
authored
[Documentation] Offsite Payments / Universal Links (#143)
* Improve documentation * Update code example for universal links * Add section for diagnostics
1 parent 01ef5f8 commit 126ab4b

File tree

8 files changed

+376
-111
lines changed

8 files changed

+376
-111
lines changed

CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Contributing
22

3+
We welcome code contributions, feature requests, and reporting of issues. Please
4+
see [guidelines and instructions](.github/CONTRIBUTING.md).
5+
6+
---
7+
38
This repo is subdivided into 3 parts using yarn workspaces:
49

510
- The base repo (workspace name = `checkout-sheet-kit-react-native`)
@@ -94,3 +99,44 @@ yarn sample test:ios
9499
# Run Java tests for the Native Module
95100
yarn sample test:android
96101
```
102+
103+
## Running the sample app
104+
105+
To run the sample app in this repo, first clone the repo and run the following
106+
commands at the root of the project directory.
107+
108+
### Install NPM dependencies
109+
110+
```sh
111+
yarn
112+
```
113+
114+
### Install Cocoapods
115+
116+
```sh
117+
yarn pod-install sample/ios
118+
```
119+
120+
### Build the local module
121+
122+
```sh
123+
yarn module build
124+
```
125+
126+
### Update the dotenv file
127+
128+
Replace the details in the `sample/.env.example` file and rename it to
129+
`sample/.env`
130+
131+
```
132+
# Storefront Details
133+
STOREFRONT_DOMAIN="YOUR_STORE.myshopify.com"
134+
STOREFRONT_ACCESS_TOKEN="YOUR_PUBLIC_STOREFRONT_ACCESS_TOKEN"
135+
STOREFRONT_VERSION="2024-04"
136+
```
137+
138+
### Start the sample app
139+
140+
```sh
141+
yarn sample start
142+
```

0 commit comments

Comments
 (0)