Zapp! supports the importing of any Dart or Flutter application directly from GitHub. This is a great way to quickly showcase an application without setting up a local environment.
Importing from GitHub is also benefical if you wish to maintain examples alongside your own pub package and not worry about syncing with Zapp!.
Importing a GitHub repository#
Zapp! supports importing projects from the root of a repository, sub-directory, branch, ref, or tag.
Provide the direct GitHub URL pathname to the URL
and the code will be imported.
Example 1: Importing a repository
Example 2: Importing a sub-directory
When importing a GitHub repository, the following requirements must be met:
- The repository path provided must contain a
- The repository path provided must contain runnable example, Zapp! supports:
- The repository must be less than X MB in size.
Imported GitHub projects will be cached based on the latest Commit SHA - if you modify the code on GitHub, the next import of the project will re-import the latest code.
Importing a GitHub Gist#
Gists are a common way to share snippests of code without managing a repository.
You can import Gists via the URL
When importing a GitHub Gist, the following requirements must be met:
- The Gist must contain a
- The Gist may optionally contain a
pubspec.yamlfile (if not provided, one will be automatically generated).
Gists are cached based on their ID alongwith the latest updated timestamp. If you modify the Gist, the next import of the project will re-import the latest code.