GitHub Integration
Learn how to connect Squadbase with GitHub to manage source code and import existing projects.
By integrating GitHub with Squadbase, you can:
- Push dashboard source code created in Squadbase to your own repository
- Import existing dashboard code (such as Next.js projects) from your repository into Squadbase for further development
Push Squadbase Code to Your Repository
Follow these steps to add your Squadbase dashboard source code to your own GitHub repository.
Connect Your Squadbase Account to GitHub
Click Settings to open the modal, then click Connect to GitHub Repository.
Follow the prompts to view your profile details.
Under connected accounts, click + Connect Account and select GitHub.
Install the Squadbase App on Your GitHub Organization
Click Install GitHub App to navigate to GitHub.
Choose whether to grant access to all repositories or only select repositories.
When you see the following screen, the GitHub App has been installed successfully.
Working with Connected GitHub Repositories
Once GitHub is connected, open Settings again and click Connect to GitHub Repository. This allows you to create a new repository in your connected Organization containing the codebase you built in Squadbase.
Import an Existing Repository into Squadbase
You can also import existing dashboard code (such as Next.js projects) from your GitHub repository to develop within Squadbase.
When creating a new project, expand Developer Options at the bottom. Here you can select your Organization and connect an existing GitHub repository to Squadbase, enabling you to edit the code directly in the Squadbase editor.
Any changes you make in Squadbase can be pushed back to your repository.
Important Notes on GitHub Account Linking
In Squadbase, a single GitHub account cannot be linked to multiple Squadbase accounts. Additionally, if a Squadbase user already exists with the same email address as your GitHub account, that user takes priority.
This behavior is based on the following policies:
Email Address as Identity Verification
The email address registered with your GitHub account is critical for identifying users. We assume that each email address corresponds to exactly one individual.
Security-Driven Restriction
Allowing the same GitHub account to link to different Squadbase accounts (with different email addresses) could lead to duplicate credentials and unintended permission grants. Since Squadbase manages project imports and deployments through team roles, this restriction is essential for maintaining security.
Troubleshooting GitHub Integration
Here are solutions for common issues that may occur when connecting to GitHub.
Repository Not Showing Up
If you cannot find a repository in the list, verify that access to that repository is enabled in the Repository access settings.
Organization Not Showing Up
If your GitHub Organization is not appearing, check the following:
- Go to your Organization's page on GitHub
- Open Settings
- Navigate to Third-party Access > GitHub Apps
- Confirm that Squadbase is listed under Installed GitHub Apps
Make sure the GitHub App is also installed on your personal account, not just the Organization.
GitHub Account Linking Error (ERROR: GitHub Account Already Connected to Another User)
If you see this error, one of the following conditions applies:
The GitHub Account Is Already Linked to Another Squadbase Account
In this case, you cannot link the GitHub account to a new Squadbase account. Either unlink the GitHub account from the existing Squadbase account, or use a different GitHub account.
Another Squadbase User Has the Same Email Address as Your GitHub Account
In this case, only the Squadbase user whose email matches the GitHub account can use it. You will need to delete one of the conflicting accounts.