From 8b4d9960c024456e1038fa4038038b6edae953b9 Mon Sep 17 00:00:00 2001 From: Ehud Adler Date: Mon, 11 Mar 2019 10:51:19 -0400 Subject: [PATCH 1/3] Update Setup.md --- Setup.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/Setup.md b/Setup.md index 94baec236..7e91e3b6e 100644 --- a/Setup.md +++ b/Setup.md @@ -1,18 +1,18 @@ # Getting Started With GitHawk -First off, welcome to the GitHawk community! +First off, welcome to the GitHawk community! 👋 -This guide will walk through the setup process required in order to get the GitHawk app running properly. +This guide will walk through the setup process required in order to get the GitHawk app up and running. ## 1. Cloning the repo 1. Create or navigation to a folder/directory where you’ll store the GitHawk project. Example: `mkdir ./desktop/GitHawkApp/` -2. In terminal clone the repo using: `git clone https://github.com//GitHawk.git` +2. In terminal clone the repo using: `git clone https://github.com//GitHawk.git` ## 2. Installing -``` +```bash cd GitHawk bundle bundle exec pod install @@ -43,14 +43,23 @@ To add the Client ID and Client Secret to the App, follow these steps: The copy of the scheme is to avoid commiting your private environement variable to the repository. +> Checkpoint: At this point you should be able to successfully build the app on the simulator + +🎉 The project is officially set up! 🎉 + +At this point you can begin making changes and testing on your simulator. +If you would like to test on a physical device, one more step remains. + ## 4. Setting up code-signing (With automatic code-signing) +> ⚠️ **1. This step is only if you would like to test/run the app on your physical device 2. This step changes the bundleID and groupID, keep in mind when you commit to leave these changes out** + 1. Open the Xcode workspace called: `Freetime.xcworkspace` (`open Freetime.xcworkspace`) - **Setting up bundle and group ID’s** - - - - - +**Setting up bundle and group ID’s** +- - - - 2. Open the projects settings ![](./Design/projectIcon.png). On the left there under Targets should be: @@ -92,7 +101,7 @@ On the left there under Targets should be: 2. Expand `NSExtension` > `NSExtensionAttributes` 4. Change `WKAppBundleIdentifier` from *com.xxxx.freetime.watchkitapp* ➡️ the FreetimeWatch Target Bundle ID (*com.``.freetime.watchkitapp*) -> Checkpoint: At this point you should be able to successfully build the app (But not able to sign in) +> Checkpoint: At this point you should be able to successfully build the app on your physical device Build and Code away! From 2225f868c875720829d42e424b47773b288ad887 Mon Sep 17 00:00:00 2001 From: Ehud Adler Date: Tue, 12 Mar 2019 21:22:19 -0400 Subject: [PATCH 2/3] Update Setup.md Added fork --- Setup.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Setup.md b/Setup.md index 7e91e3b6e..a21e3d09d 100644 --- a/Setup.md +++ b/Setup.md @@ -3,7 +3,9 @@ First off, welcome to the GitHawk community! 👋 This guide will walk through the setup process required in order to get the GitHawk app up and running. -## 1. Cloning the repo +## 1a. Fork the repo +Head to [the GitHawk repo](https://github.com/GitHawkApp/GitHawk) and tap the Fork button located at the top right of the screen. +## 1b. Cloning the repo 1. Create or navigation to a folder/directory where you’ll store the GitHawk project. Example: `mkdir ./desktop/GitHawkApp/` From 5fe09c97faf04e62c99c4bbf58b92f2bdff51162 Mon Sep 17 00:00:00 2001 From: Ehud Adler Date: Tue, 12 Mar 2019 21:24:35 -0400 Subject: [PATCH 3/3] Update Setup.md Updated wording and added extra info step to added client id's --- Setup.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/Setup.md b/Setup.md index a21e3d09d..c4015d4c7 100644 --- a/Setup.md +++ b/Setup.md @@ -5,8 +5,9 @@ This guide will walk through the setup process required in order to get the GitH ## 1a. Fork the repo Head to [the GitHawk repo](https://github.com/GitHawkApp/GitHawk) and tap the Fork button located at the top right of the screen. + ## 1b. Cloning the repo -1. Create or navigation to a folder/directory where you’ll store the GitHawk project. +1. Create or navigate to a folder/directory where you’ll store the GitHawk project. Example: `mkdir ./desktop/GitHawkApp/` @@ -35,13 +36,14 @@ You will be redirected to the application page where you can access your Client To add the Client ID and Client Secret to the App, follow these steps: -1. In Xcode, go to `Product` (in the Menu bar) > `Scheme` > `Manage Schemes...` -2. Select `Freetime-AppCenter` and click the cog. -3. Click on `Duplicate`. -4. Uncheck the `Shared` checkbox. -5. Select `Copy of Freetime-AppCenter` and click on `Edit...` -6. Go to `Run` > `Arguments` -7. Add your Client ID (`GITHUB_CLIENT_ID` as key) and Client Secret (`GITHUB_CLIENT_SECRET`) to the Environment Variables. +1. In the directory you created, open the {YOUR_DIR}/GitHawk/Freetime.xcworkspace file. +2. In Xcode, go to `Product` (in the Menu bar) > `Scheme` > `Manage Schemes...` +3. Select `Freetime-AppCenter` and click the cog. +4. Click on `Duplicate`. +5. Select `Copy of Freetime-AppCenter` and uncheck "Shared" checkbox. +6. With 'Copy of Freetime-Appcenter' selected, click on `Edit...` +7. Go to `Run` > `Arguments` +8. Add your Client ID (`GITHUB_CLIENT_ID` as key) and Client Secret (`GITHUB_CLIENT_SECRET`) to the Environment Variables. The copy of the scheme is to avoid commiting your private environement variable to the repository.