Skip to main content
GitHub Sync connects your Bloom app to a GitHub repository, enabling bidirectional synchronization. Changes you make in Bloom automatically push to GitHub, and changes pushed to GitHub sync back to Bloom.
GitHub Sync is currently in beta and available on Premium plans and above.

​
Setting Up GitHub Sync

You can set up GitHub Sync from your app’s settings panel. GitHub Sync Setup
1

Create a new repository

Create a new empty repository on GitHub. The repository must be empty for the initial sync to work correctly.
Click Create New Repository in the setup panel to open GitHub directly.
2

Install the GitHub App

Install the Bloom GitHub App and grant it access to your repository. This allows Bloom to read from and write to your repo.Click Install GitHub App to begin the installation process. You can grant access to:
  • All repositories in your account
  • Only select repositories (recommended)
3

Connect your repository

Enter your repository name in the format username/repository or organization/repository, then click Configure.Alternatively, click Browse Available Repositories to select from repositories you’ve already granted access to.
Once connected, your app’s code will sync to the repository automatically.

​
How Sync Works

GitHub Sync maintains bidirectional synchronization between Bloom and your repository.
Changes made in Bloom push to GitHub automatically.When you generate new features, edit code, or make any changes in Bloom, those changes are committed and pushed to your connected repository.
  • Each generation creates a new commit
  • Commits include descriptive messages
  • Your full commit history is preserved

​
Use Cases

Work in Your IDE

Use VS Code, Cursor, or any editor you prefer. Push changes to GitHub and they’ll appear in Bloom.

Team Collaboration

Multiple team members can work on the same app using standard Git workflows.

Version Control

Full Git history lets you track changes, revert mistakes, and understand how your app evolved.

CI/CD Integration

Connect your repo to GitHub Actions or other CI/CD tools for automated testing and deployment.

​
Working Locally

Once your app is synced to GitHub, you can clone it and run it locally.

​
Prerequisites

  • Bun (JavaScript runtime and package manager)
  • Convex CLI (for running the backend)

​
Running Your App

1

Clone and install

git clone https://github.com/your-username/your-app.git
cd your-app
bun install
2

Set up environment variables

Copy the example environment file and fill in your Convex deployment details:
cp .env.example .env
You can find your Convex deployment URL in your Convex dashboard.
3

Start the development server

bun run dev
This starts both the Expo frontend and Convex backend.
See App Structure to understand how your project files are organized.

​
Requirements and Limitations

GitHub Sync is available on Premium plans and above ($50/month).View pricing →
  • The repository must be empty when you first connect
  • You must have write access to the repository
  • The Bloom GitHub App must be installed and authorized
GitHub Sync is currently in beta. You may encounter:
  • Occasional sync delays
  • Edge cases with complex merge conflicts
Report any issues to support@bloom.diy or in our Discord.

​
What’s Next?

App Structure

Understand how your synced codebase is organized

Backend Dashboard

Monitor your app’s performance and database