Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Create readme file to help with building and running sample apps #370

Merged
merged 3 commits into from
Jan 6, 2025
Merged

chore: Create readme file to help with building and running sample apps #370

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
046d84e
Create readme file to help with building and running sample apps
mahmoud-elmorabea Jan 5, 2025
458937c
Added a section about setting up workspace credentials
mahmoud-elmorabea Jan 6, 2025
eb2bbe0
Updated section about setting up workspace credentials
mahmoud-elmorabea Jan 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 46 additions & 0 deletions Apps/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Running the sample apps

You can use the following steps to run any of our sample apps.

## Build the SDK

At the root directory of this repository run the following command to build the SDK:

```bash
npm install
```

## Connect the app to a workspace in Customer.io

Make a copy of `env.sample.js` by running `cp env.sample.js env.js` at sample app root directory
Copy link
Contributor

Choose a reason for hiding this comment

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

We need to copy Env.swift.example as well, otherwise iOS apps will not compile. Also, there are no instructions for signing iOS app, adding them will be helpful for anyone from CIO setting it up the first time.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What are you suggesting for iOS signing? Downloading the provisioning profiles you mean? Otherwise, everything should already be setup


Update env.js with your `siteId` and `cdpApiKey`

## Build one of the sample apps
mahmoud-elmorabea marked this conversation as resolved.
Show resolved Hide resolved

Depending on which sample app you want to test, navigate to the directory of that sample app using either of these commands:

`cd Apps/APN/` or `cd Apps/FCM`

Then run the following commands:

```bash
npm run preinstall
npm install
```

## Run the sample app

After you have built the app you can then now run it on Android or iOS using any of these commands:

To run Android:

```bash
npx react-native run-android
```

To run iOS:

```bash
npx react-native run-ios
```
Loading