Skip to content
This repository was archived by the owner on Sep 20, 2023. It is now read-only.
Merged
Changes from all commits
Commits
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
45 changes: 29 additions & 16 deletions Setup.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
# 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.
## 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 navigate 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/<YourGithubName>/GitHawk.git`
2. In terminal clone the repo using: `git clone https://github.com/<YourGithubUsername>/GitHawk.git`

## 2. Installing

```
```bash
cd GitHawk
bundle
bundle exec pod install
Expand All @@ -33,24 +36,34 @@ 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.

> 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:
Expand Down Expand Up @@ -92,7 +105,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.`<yourRegularBundleName>`.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!