Repository navigation

Guide: Creating a New GitHub App

Follow these steps to register a new application on GitHub and configure it correctly.

1. Navigate to GitHub Apps Settings

Go to GitHub Apps settings.

2. Create a New GitHub App

Click the New GitHub App button.

3. Fill Out App Details

GitHub App name: Enter your desired application name.
Homepage URL: http://localhost:3000/
Callback URL: http://localhost:3000/api/auth/callback/github
Expire user authorization tokens: Deselect this checkbox.
Setup URL: http://localhost:3000/
Webhook: Deselect the Active checkbox to disable webhooks.

4. Set Permissions

Repository Permissions

Contents: Set to Read-only

Account Permissions

Email addresses: Set to Read-only

5. Create the App

Click the Create GitHub App button at the bottom of the page.

6. Get Your Credentials

On the next page, copy your App ID and Client ID and save them securely.
Click Generate a new client secret. Copy the generated secret immediately and save it.
Important: You will not be able to see this secre t again.

7. Generate a Private Key

Scroll to the Private keys section.
Click Generate a private key. A .pem file will be downloaded.
Open the file in a code editor (e.g., VS Code), copy the entire contents (including the -----BEGIN RSA PRIVATE KEY----- and -----END RSA PRIVATE KEY----- lines).
If pasting into a configuration file (e.g., .env), wrap the entire key content in double quotes (").