Building GitHub Apps

You can build GitHub Apps for personal or public use. Learn how to register and set up permissions and authentication options for GitHub Apps.

  1. Creating a GitHub App
    You can create and register a GitHub App under your personal account or under any organization you have administrative access to.

  2. Creating custom badges for GitHub Apps
    You can replace the default badge on your GitHub App by uploading your own logo image and customizing the background.

  3. Setting Permissions for GitHub Apps
    When you create a GitHub App, you set the permissions that define the resources the app can access via the REST API v3.

  4. Authenticating with GitHub Apps
    You can authenticate as a GitHub App or as an installation.

  5. Identifying and authorizing users for GitHub Apps
    Your GitHub App can perform actions on behalf of a user, like creating an issue, creating a deployment, and using other supported endpoints. If you've enabled expiring user tokens, then you will need to set up a refresh token flow. For more information, see "Refreshing user-to-server access tokens."

  6. Understanding rate limits for GitHub Apps
    Rate limits for GitHub Apps help control the rate of traffic.