Skip to content
This repository was archived by the owner on Sep 20, 2023. It is now read-only.

Commit f8efbc5

Browse files
HuddieBasThomas
authored andcommitted
Update Setup.md (#2684)
* Update Setup.md * Update Setup.md Added fork * Update Setup.md Updated wording and added extra info step to added client id's
1 parent 424b6c4 commit f8efbc5

File tree

1 file changed

+29
-16
lines changed

1 file changed

+29
-16
lines changed

Setup.md

Lines changed: 29 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
# Getting Started With GitHawk
2-
First off, welcome to the GitHawk community!
2+
First off, welcome to the GitHawk community! 👋
33

4-
This guide will walk through the setup process required in order to get the GitHawk app running properly.
4+
This guide will walk through the setup process required in order to get the GitHawk app up and running.
55

6-
## 1. Cloning the repo
7-
1. Create or navigation to a folder/directory where you’ll store the GitHawk project.
6+
## 1a. Fork the repo
7+
Head to [the GitHawk repo](https://github.com/GitHawkApp/GitHawk) and tap the Fork button located at the top right of the screen.
8+
9+
## 1b. Cloning the repo
10+
1. Create or navigate to a folder/directory where you’ll store the GitHawk project.
811

912
Example: `mkdir ./desktop/GitHawkApp/`
1013

11-
2. In terminal clone the repo using: `git clone https://github.com/<YourGithubName>/GitHawk.git`
14+
2. In terminal clone the repo using: `git clone https://github.com/<YourGithubUsername>/GitHawk.git`
1215

1316
## 2. Installing
1417

15-
```
18+
```bash
1619
cd GitHawk
1720
bundle
1821
bundle exec pod install
@@ -33,24 +36,34 @@ You will be redirected to the application page where you can access your Client
3336

3437
To add the Client ID and Client Secret to the App, follow these steps:
3538

36-
1. In Xcode, go to `Product` (in the Menu bar) > `Scheme` > `Manage Schemes...`
37-
2. Select `Freetime-AppCenter` and click the cog.
38-
3. Click on `Duplicate`.
39-
4. Uncheck the `Shared` checkbox.
40-
5. Select `Copy of Freetime-AppCenter` and click on `Edit...`
41-
6. Go to `Run` > `Arguments`
42-
7. Add your Client ID (`GITHUB_CLIENT_ID` as key) and Client Secret (`GITHUB_CLIENT_SECRET`) to the Environment Variables.
39+
1. In the directory you created, open the {YOUR_DIR}/GitHawk/Freetime.xcworkspace file.
40+
2. In Xcode, go to `Product` (in the Menu bar) > `Scheme` > `Manage Schemes...`
41+
3. Select `Freetime-AppCenter` and click the cog.
42+
4. Click on `Duplicate`.
43+
5. Select `Copy of Freetime-AppCenter` and uncheck "Shared" checkbox.
44+
6. With 'Copy of Freetime-Appcenter' selected, click on `Edit...`
45+
7. Go to `Run` > `Arguments`
46+
8. Add your Client ID (`GITHUB_CLIENT_ID` as key) and Client Secret (`GITHUB_CLIENT_SECRET`) to the Environment Variables.
4347

4448
The copy of the scheme is to avoid commiting your private environement variable to the repository.
4549

50+
> Checkpoint: At this point you should be able to successfully build the app on the simulator
51+
52+
🎉 The project is officially set up! 🎉
53+
54+
At this point you can begin making changes and testing on your simulator.
55+
If you would like to test on a physical device, one more step remains.
56+
4657
## 4. Setting up code-signing (With automatic code-signing)
4758

59+
> ⚠️ **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**
60+
4861
1. Open the Xcode workspace called: `Freetime.xcworkspace`
4962
(`open Freetime.xcworkspace`)
5063

5164

52-
**Setting up bundle and group ID’s**
53-
- - - -
65+
**Setting up bundle and group ID’s**
66+
- - - -
5467

5568
2. Open the projects settings ![](./Design/projectIcon.png).
5669
On the left there under Targets should be:
@@ -92,7 +105,7 @@ On the left there under Targets should be:
92105
2. Expand `NSExtension` > `NSExtensionAttributes`
93106
4. Change `WKAppBundleIdentifier` from *com.xxxx.freetime.watchkitapp* ➡️ the FreetimeWatch Target Bundle ID (*com.`<yourRegularBundleName>`.freetime.watchkitapp*)
94107

95-
> Checkpoint: At this point you should be able to successfully build the app (But not able to sign in)
108+
> Checkpoint: At this point you should be able to successfully build the app on your physical device
96109
97110

98111
Build and Code away!

0 commit comments

Comments
 (0)