GitHub Integration

Connect Rofy with GitHub to seamlessly save, version, and collaborate on your projects — all without leaving your workspace.

---

Why Use GitHub with Rofy?

Rofy’s GitHub integration lets you:

• Manage projects with full version control
• Collaborate with teammates easily
• Back up your work automatically
• Push and pull code without leaving Rofy

You can connect your GitHub account, manage repositories and branches, and work across multiple environments — all from inside Rofy.

---

Use Case 1: Starting a New Project and Saving to GitHub

:::info Use this workflow when you’re starting a brand-new app and want version control from day one. :::

Step 1: Start Your Project

• Begin a new task in Rofy
• Describe your project (e.g. “Build a task management app”)
• Let the agent build your application
• Test it using the Preview feature

Step 2: Connect GitHub (First Time Only)

• Click your profile icon in Rofy
• Select Connect GitHub
• Authorize Rofy on the GitHub login screen
• Grant repository access permissions

Step 3: Save to GitHub

• Click Save to GitHub in the chat interface
• Choose:
  • Create a new repository or
  • Select an existing repository
• Select the branch (usually main for new projects)
• Click PUSH TO GITHUB

Your project is now saved with automatic commit messages.

:::success Save after major features and before big changes to keep your progress safe and well-versioned. :::

---

Use Case 2: Continuing Work on an Existing GitHub Repository

:::info Use this workflow when your project already exists on GitHub and you want to continue building it in Rofy. :::

Step 1: Start a New Task

• Begin a new task in Rofy
• Click the GitHub button in the chat screen

Step 2: Pull from GitHub

• Choose Pull from GitHub
• Select your repository
• Pick the branch you want to import
• Rofy loads your existing code into the workspace

Step 3: Continue Development

• Explore files using the file viewer
• Add features, fix bugs, and preview changes
• Use natural language in chat to guide updates

Step 4: Save Progress

• Click Save to GitHub regularly
• Select the same repository and branch
• Rofy automatically commits your changes

:::success Always pull the latest version before starting a new session — especially when collaborating. :::

---

Use Case 3: Team Collaboration Workflow

:::info Rofy works seamlessly with GitHub’s collaboration tools, making teamwork smooth and conflict-free. :::

Step 1: Project Owner Setup

• Create the initial project in Rofy
• Save it to a shared GitHub repository
• Add teammates as collaborators on GitHub

Step 2: Team Member Workflow

• Each member connects their GitHub account to Rofy
• Pulls the shared repository into their workspace
• Works independently on assigned features

Step 3: Using Feature Branches

• Create feature branches when saving:
  • feature-user-auth
  • feature-payments
• Push changes to feature branches
• Keep main stable and production-ready

Step 4: Code Integration

• Open pull requests on GitHub
• Review and merge approved changes into main
• Pull the latest version into Rofy

:::success Use clear branch names, coordinate tasks, and always test before merging into main. :::

---

Use Case 4: Managing Multiple Project Versions

:::info Perfect for experimentation, A/B ideas, or long-running feature development. :::

Step 1: Create an Experimental Branch

• Open your project in Rofy
• Save to GitHub using a new branch (e.g. experimental-ui)
• Build and test features in isolation

Step 2: Switch Between Versions

• Main version: Pull from main
• Experimental version: Pull from experimental-ui

Each branch represents a separate version of your app.

Step 3: Merge Successful Experiments

• Use GitHub pull requests to merge changes into main
• Delete unused branches once merged

:::success Keep experimental branches isolated until features are stable and reviewed. :::

---

Use Case 5: Backup and Recovery Workflow

:::info Rofy syncs with GitHub automatically — but regular manual saves give extra safety. :::

Step 1: Regular Backup Schedule

• Save after each major feature
• Save before big refactors
• Save at the end of every session

Step 2: Recovery Process

• Start a new task in Rofy
• Pull the last saved version from GitHub
• Continue development from the last stable commit

Step 3: Version History

• Review commit history on GitHub
• Revert to previous versions if needed
• Track progress over time

:::success Frequent saves ensure you can always recover without losing progress. :::

---

Troubleshooting Common GitHub Issues

Connection Problems

Issue: GitHub connection isn’t working

Solution:

• Go to GitHub → Settings → Applications → Installed GitHub Apps
• Find Rofy and uninstall it
• Reconnect your GitHub account in Rofy

---

Push Conflicts

Issue: Conflict errors when pushing

Solution:

• Save to a new branch instead of main
• Resolve conflicts later via GitHub pull requests

This keeps your latest work safe without overwriting production code.

---

Missing Repositories

Issue: Repositories don’t appear in Rofy

Solution:

• Confirm your GitHub account is connected
• Check repository access permissions
• Disconnect and reconnect GitHub

---

Best Practices

• Save early and often
• Pull before starting new work
• Use branches for experiments and features
• Keep main clean and deployable

With GitHub + Rofy, your code stays safe, collaborative, and always recoverable 🚀