You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 20, 2023. It is now read-only.
Copy file name to clipboardExpand all lines: Setup.md
+29-16Lines changed: 29 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,21 @@
1
1
# Getting Started With GitHawk
2
-
First off, welcome to the GitHawk community!
2
+
First off, welcome to the GitHawk community! 👋
3
3
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.
5
5
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.
8
11
9
12
Example: `mkdir ./desktop/GitHawkApp/`
10
13
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`
12
15
13
16
## 2. Installing
14
17
15
-
```
18
+
```bash
16
19
cd GitHawk
17
20
bundle
18
21
bundle exec pod install
@@ -33,24 +36,34 @@ You will be redirected to the application page where you can access your Client
33
36
34
37
To add the Client ID and Client Secret to the App, follow these steps:
35
38
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.
43
47
44
48
The copy of the scheme is to avoid commiting your private environement variable to the repository.
45
49
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
+
46
57
## 4. Setting up code-signing (With automatic code-signing)
47
58
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
+
48
61
1. Open the Xcode workspace called: `Freetime.xcworkspace`
49
62
(`open Freetime.xcworkspace`)
50
63
51
64
52
-
**Setting up bundle and group ID’s**
53
-
- - - -
65
+
**Setting up bundle and group ID’s**
66
+
- - - -
54
67
55
68
2. Open the projects settings .
56
69
On the left there under Targets should be:
@@ -92,7 +105,7 @@ On the left there under Targets should be:
92
105
2. Expand `NSExtension` > `NSExtensionAttributes`
93
106
4. Change `WKAppBundleIdentifier` from *com.xxxx.freetime.watchkitapp* ➡️ the FreetimeWatch Target Bundle ID (*com.`<yourRegularBundleName>`.freetime.watchkitapp*)
94
107
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
0 commit comments