Skip to content

Conversation

@markmur
Copy link
Contributor

@markmur markmur commented Dec 6, 2024

What changes are you making?

  • Adds section on Offsite Payments
  • Improves guidance on Preloading
  • Adds note about cache invalidation
  • Improves table of contents

@markmur markmur self-assigned this Dec 6, 2024
@markmur markmur requested a review from a team as a code owner December 6, 2024 15:22
Comment on lines +102 to +142

## Running the sample app

To run the sample app in this repo, first clone the repo and run the following
commands at the root of the project directory.

### Install NPM dependencies

```sh
yarn
```

### Install Cocoapods

```sh
yarn pod-install sample/ios
```

### Build the local module

```sh
yarn module build
```

### Update the dotenv file

Replace the details in the `sample/.env.example` file and rename it to
`sample/.env`

```
# Storefront Details
STOREFRONT_DOMAIN="YOUR_STORE.myshopify.com"
STOREFRONT_ACCESS_TOKEN="YOUR_PUBLIC_STOREFRONT_ACCESS_TOKEN"
STOREFRONT_VERSION="2024-04"
```

### Start the sample app

```sh
yarn sample start
```
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moving this section from the README here

README.md Outdated
Comment on lines 24 to 58
- [Platform Requirements](#platform-requirements)
- [Getting Started](#getting-started)
- [1. Installation](#1-installation)
- [2. Minimum Android requirements](#2-minimum-android-requirements)
- [3. Minimum iOS requirements](#3-minimum-ios-requirements)
- [Basic Usage](#basic-usage)
- [Programmatic Usage](#programmatic-usage)
- [Usage with the Shopify Storefront API](#usage-with-the-shopify-storefront-api)
- [Configuration](#configuration)
- [`colorScheme`](#colorscheme)
- [`colors`](#colors)
- [Localization](#localization)
- [Checkout Sheet title](#checkout-sheet-title)
- [iOS](#ios)
- [Android](#android)
- [Currency](#currency)
- [Language](#language)
- [Preloading](#preloading)
- [Important considerations](#important-considerations)
- [Flash Sales](#flash-sales)
- [When to preload](#when-to-preload)
- [Cache invalidation](#cache-invalidation)
- [Checkout lifecycle](#checkout-lifecycle)
- [`addEventListener(eventName, callback)`](#addeventlistenereventname-callback)
- [`removeEventListeners(eventName)`](#removeeventlistenerseventname)
- [Behavioral data - Web pixels](#behavioral-data---web-pixels)
- [Identity \& customer accounts](#identity--customer-accounts)
- [Cart: buyer bag, identity, and preferences](#cart-buyer-bag-identity-and-preferences)
- [Multipass](#multipass)
- [Shop Pay](#shop-pay)
- [Customer Account API](#customer-account-api)
- [Offsite Payments](#offsite-payments)
- [Universal Links - iOS](#universal-links---ios)
- [Contributing](#contributing)
- [License](#license)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is autogenerated using the "Markdown All in one" extension

@markmur markmur force-pushed the markmur/documentation-offsite-payments branch 3 times, most recently from 6c7be86 to 11bc3ff Compare December 6, 2024 15:25
@markmur markmur force-pushed the markmur/documentation-offsite-payments branch from 11bc3ff to 25c1a1a Compare December 6, 2024 15:26
@markmur markmur force-pushed the markmur/documentation-offsite-payments branch from e933c2c to 121d8bd Compare December 6, 2024 16:40
@markmur markmur changed the title Improve documentation [Documentation] Offsite Payments / Universal Links Dec 6, 2024
@markmur markmur requested review from anulind and kiftio December 9, 2024 10:17
@markmur markmur merged commit 126ab4b into main Dec 9, 2024
8 checks passed
@markmur markmur deleted the markmur/documentation-offsite-payments branch December 9, 2024 11:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants