Skip to content

Commit c638389

Browse files
committed
Small fixed
1 parent 33cdee7 commit c638389

File tree

1 file changed

+23
-20
lines changed

1 file changed

+23
-20
lines changed

docs/integrations/git.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ Git integration is only available for users on the **Pro plan and above**.
2020

2121
You can connect a repository in two main ways:
2222

23-
- **Clone Codebase**: Use this option when you want to start a new project in Dreamflow using an existing Git repository.
23+
- **Clone Codebase**: Use this option when you want to start a new project from an existing Flutter app.
2424

25-
- **Connect Project to Git**: Use this option when you already have a project built inside Dreamflow and want to link it to a Git repository.
25+
- **Connect Project to Git**: Use this option when you already have a project in Dreamflow and want to link it to a Git repository.
2626

2727
:::warning
2828

29-
Currently, it does not support multi-user collaboration within the same repository. If multiple Dreamflow projects attempt to use the same repo, the system will detect and restrict it.
29+
Currently, Dreamflow does not support multi-user collaboration within the same repository. If multiple Dreamflow projects attempt to use the same repo, the system will detect and restrict it.
3030

31-
For team collaboration, please contact the **Enterprise team**.
31+
For team collaboration, please reach out regarding the [**Enterprise Plan**](https://dreamflow.app#pricing).
3232

3333
:::
3434

@@ -81,6 +81,25 @@ Support for monorepos is planned for a future update.
8181

8282
:::
8383

84+
#### Project Import Requirements
85+
86+
When importing an existing repo into Dreamflow, Dreamflow expects:
87+
88+
1. **Flutter app:** Dreamflow checks for a `pubspec.yaml` file. If not found, import fails because the repository is not recognized as a Flutter project.
89+
- **Monorepos** - repositories containing multiple nested Flutter projects - aren’t supported yet, but support is on our roadmap.
90+
2. **Web Support**: Dreamflow requires apps to run in the **web preview environment**. Repos using packages that break web may fail to load or run incorrectly.
91+
- The Dreamflow preview uses Flutter's canvaskit renderer. If the project specifically uses the HTML renderer setting, the preview may not load
92+
93+
There are a few other things that might go wrong when importing an existing Flutter repo:
94+
95+
- **Unsupported Flutter Version**: If the project uses a Flutter version Dreamflow does not support, import will fail with an error. There are also cases where implicit version ranges cause analyzer issues due to breaking Flutter changes.
96+
- **Theme Issues** : Certain theme configurations might not render properly in the Dreamflow editor - you may not see all of your colors or text styles in the Theme panel.
97+
- **Local Servers / Background Processes**: Projects requiring local API servers or background processes during development will fail to run inside Dreamflow.
98+
- **Private Dependencies**: If the project depends on packages hosted in private servers that Dreamflow cannot access, the import will fail.
99+
- **Code Generation Tools** (build_runner, freezed, flutter_localizations): You cannot currently execute scripts inside of the Dreamflow builder. If the imported project depends on code generation, you will need to generate Dart files outside of Dreamflow and commit them to the repo.
100+
- **`-dart-define` Requirements**: You must provide a default configuration so the app can run without requiring any --dart-define parameters.
101+
- **Project May Be Too Large**: Very large repositories may take a long time to start and you may see some performance degradation in the Dreamflow builder.
102+
84103
### Connect Project to Git
85104

86105
To connect a Dreamflow project to Git repo:
@@ -316,19 +335,3 @@ Once disconnected, your project will no longer sync changes with the remote repo
316335

317336
![disconnect-repo.avif](imgs/disconnect-repo.avif)
318337

319-
## Known Limitations
320-
321-
When importing a Git repository into Dreamflow, you may encounter certain limitations based on the current platform capabilities.
322-
323-
- **Project May Be Too Large**: Very large repositories may timeout during import. If this happens, users are encouraged to contact the **Enterprise team** for support with large or complex projects.
324-
- **Repository Is Not a Flutter Project**: Dreamflow checks for a `pubspec.yaml` file. If not found, import fails because the repository is not recognized as a Flutter project.
325-
- **Monorepos Are Not Supported Yet**: If the repository root does not contain a Flutter project or contains multiple projects, Dreamflow will show an error.
326-
- **Multiple Flutter Projects Detected**: Dreamflow currently supports importing **only a single Flutter project**. Repositories containing multiple Flutter apps will not import.
327-
- **Unsupported Flutter Version**: If the project uses a Flutter version Dreamflow does not support, import will fail with an error. There are also cases where implicit version ranges cause analyzer issues due to breaking Flutter changes.
328-
- **Code Generation Tools** (build_runner, freezed, flutter_localizations): If the project depends on code generation but the generated files are not committed, import may fail or show errors.
329-
- **Theme Issues** (Theme v2): Certain theme configurations might not render properly in the editor, even though they are not blockers.
330-
- **Private / Non-Public Dependencies**: If the project depends on packages hosted in private servers that Dreamflow cannot access, import will fail.
331-
- **Web Support Required**: Dreamflow requires apps to run in the **web preview environment**. Repos using packages that break web may fail to load or run incorrectly.
332-
- **Local Servers / Background Processes**: Projects requiring local API servers or background processes during development will fail to run inside Dreamflow.
333-
- **`-dart-define` Required**: If the project requires dart-define flags and defaults are not supplied, Dreamflow may run the project with missing configurations.
334-
- **HTML Renderer Issues**: If the project depends on a specific HTML renderer setting, the preview may not load.

0 commit comments

Comments
 (0)