Sitesurface Logo

Sitesurface Flutter Deploy

Deploy Your App To Gihub Pages Deploy your website to github pages hassle free with one command.

If you find this package useful like 👍 the package and share with other developers.


Chat Image


Dart >=3.0.2 and Flutter >=1.17.0

Getting Started

A command-line tool which simplifies the task of uploading your flutter app to gihub pages. It also fixes some of the common issues faced by developers while deploying to github pages.

📖 Guide

1. Setup the config file

Add your Sitesurface Flutter Deploy configuration to your pubspec.yaml. An example is shown below. More complex examples can be found in the example projects.

  sitesurface_flutter_deploy: "^0.0.2"

  repository: "<url of repository where you want to deploy>"

2. Run the package

After setting up the configuration, all that is left to do is run the package.

flutter pub get
dart run sitesurface_flutter_deploy

If you name your configuration file something other than sitesurface_flutter_deploy.yaml or pubspec.yaml you will need to specify the name of the file when running the package.

flutter pub get
flutter pub run sitesurface_flutter_deploy --path=path/to/my/file.yaml

Note: If you are not using the existing pubspec.yaml ensure that your config file is located in the same directory as it.

🔍 Attributes

Shown below is the full list of attributes which you can specify within your Sitesurface Flutter Deploy configuration.

  • repository: The url of Github Repository where you want to deploy your site.
  • build: If you want to override the commands used by package to build the web project then you can pass your commands here

Issues and feedback

Please file Sitesurface Flutter Deploy specific issues, bugs, or feature requests in our issue tracker.

Plugin issues that are not specific to Sitesurface Flutter Chat can be filed in the Flutter issue tracker.


Feel free to contribute to this project.

If you find a bug or want a feature, but don’t know how to fix/implement it, please fill an issue. If you fixed a bug or implemented a feature, please send a pull request.


View Github