CONTRIBUTING.md

• GistHub App
  • 1. Cloning the repo
  • 2. Installing
  • 3. Setting up OAuth for login
    • Registering
• Modularization
  • Add new Module
  • Resolve all Modules
• GraphQL
  • Using Xcode
  • Using CLI

GistHub App

1. Cloning the repo

1. Tap the Fork button of this repo
2. git clone https://github.com/YourGitHubUsername/GistHub.git

2. Installing

Just open the GistHub.xcodeproj and waiting for dependencies load.

3. Setting up OAuth for login

You'll need to register new OAuth application.

Registering

Make sure the Authorization callback URL is set to gisthub://. The others can be filled in as you wish.

You will be redirected to the application page where you can access your Client ID and Client Secret.

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

1. Open the GistHub/GistHub.xcodeproj file.
2. Go to Product > Scheme > Manage Schemes...
3. Select GistHub and click the cog.
4. Click on Duplicate.
5. Select Copy of GistHub and uncheck "Shared" checkbox, you can rename it as you want.
6. With 'Copy of GistHub' 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 project is officially set up! 🎉

Modularization

Add new Module

GistHub is modular via SPM (Swift Package Manager). This means that the app is divided into smaller modules or packages that can be developed and tested independently. Here's how you can add a new module to GistHub:

1. Create the new module by sh Scripts/generate_package.sh <Package Name>. Replace with the name of your new package. For example, sh Scripts/generate_package.sh MyNewPackage.
2. Drag the new module to GistHub.xcodeproj to add it to the Xcode project.

Resolve all Modules

After adding a new module and its dependencies, you need to resolve all the modules to update their dependencies and ensure that they can be built. To do this, run the following command in the terminal:

cd GistHub/
sh Scripts/resolve_packages.sh

GraphQL

Using Xcode

Open the GistHub/GistHub.xcodeproj file. Then select gpl_api_generator scheme with macOS target My Mac.

Generating code from *.graphql

1. Go to Product > Scheme > Edit Scheme...
2. Go to Run > Arguments.
3. Make sure generate argument is checked.
4. Hit run to generate.

To download the new GitHub schema

1. Go to Product > Scheme > Edit Scheme...
2. Go to Run > Arguments.
3. Make sure download argument is checked.
4. Hit run to download.

Using CLI

Generating code from *.graphql

cd graphql/generator/
swift run gpl_api_generator generate

Dowloading the new GitHub schema

cd graphql/generator/
swift run gpl_api_generator download --token <github access token>