From 046d84e65f413cb543296071062029df19d55060 Mon Sep 17 00:00:00 2001 From: Mahmoud Elmorabea Date: Sun, 5 Jan 2025 19:03:01 +0400 Subject: [PATCH 1/3] Create readme file to help with building and running sample apps --- Apps/README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 Apps/README.md diff --git a/Apps/README.md b/Apps/README.md new file mode 100644 index 00000000..6ae90f04 --- /dev/null +++ b/Apps/README.md @@ -0,0 +1,40 @@ +# 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 +``` + +## Build one of the sample apps + +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 +``` From 458937ca0b7a19f1e3e6e5e3c5ad511b610e909f Mon Sep 17 00:00:00 2001 From: Mahmoud Elmorabea Date: Mon, 6 Jan 2025 13:53:25 +0400 Subject: [PATCH 2/3] Added a section about setting up workspace credentials --- Apps/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Apps/README.md b/Apps/README.md index 6ae90f04..9febc610 100644 --- a/Apps/README.md +++ b/Apps/README.md @@ -10,6 +10,12 @@ At the root directory of this repository run the following command to build the 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 + +Update env.js with your `siteId` and `cdpApiKey` + ## Build one of the sample apps Depending on which sample app you want to test, navigate to the directory of that sample app using either of these commands: From eb2bbe0343ecb481a07df00be9f976d0666ef7d2 Mon Sep 17 00:00:00 2001 From: Mahmoud Elmorabea Date: Mon, 6 Jan 2025 20:44:27 +0400 Subject: [PATCH 3/3] Updated section about setting up workspace credentials --- Apps/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Apps/README.md b/Apps/README.md index 9febc610..cf042dd9 100644 --- a/Apps/README.md +++ b/Apps/README.md @@ -12,9 +12,10 @@ 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 - -Update env.js with your `siteId` and `cdpApiKey` +- 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` +- Make a copy of `env.sample.js` by running `cp env.sample.js env.js` at sample app root directory +- Make a copy of `Env.swift.example` by running `cp Env.swift.example Env.swift` at sample app `ios` directory (`Apps/APN/ios` or `Apps/FCM/ios`) +- Update env.js with your `siteId` and `cdpApiKey` ## Build one of the sample apps