Paraflow's GitHub integration allows you to seamlessly sync your design projects to your GitHub repository, enabling collaboration between designers and developers. With this feature, you can:

• Export your Paraflow project as a complete GitHub repository.
• Automatically generate a repository containing all design files and configurations.
• Manually sync project updates to GitHub.

Quick Start

Connect Paraflow to your GitHub

1. Click the GitHub icon in the top-right corner of the project editor.

   

2. Click Connect GitHub to authorize the Paraflow GitHub App.

   

3. After authorization is completed, the system will automatically return to Paraflow.

Create the project repository

1. Make sure your GitHub account is connected. Then click Connect Project.

   

2. Paraflow will automatically create a repository and upload your project. The initial push may take a little time.

3. Once created, Paraflow will prompt you that it is successful.

   

   • You can click View on GitHub to verify that the repository is correctly linked.
   • When you updates your project in Paraflow, you can click Sync to GitHub to upload the latest changes to the linked repository.
   • If you need to disconnect the repository, you can click Remove Repository Binding to unlink the project from GitHub.

FAQ

1. Can the generated code be used directly?

   Yes, the generated code includes complete project configurations and dependency management, making it ready for development. It’s recommended to review the README.md file for project structure details.

2. How can I modify the repository settings?

   You can directly change repository settings on the GitHub website, such as visibility, collaborators, and branch protection rules.

3. Will syncing overwrite changes made on GitHub?

   Yes, syncing will overwrite repository files with content from the Paraflow project. If you’ve made changes on GitHub, it’s recommended to back them up before syncing.

4. Can I sync to an existing repository?

   Currently, syncing to an existing repository is not supported. Each Paraflow project creates a new independent repository.

5. Will project changes automatically sync to GitHub?

   No, Paraflow does not automatically sync project changes to GitHub. You need to manually click the Sync to GitHub button to update the repository.

6. How can I revoke GitHub integration?

   You can select Disconnect GitHub in the dialog box, which will clear all bindings and revoke app authorization.