Overview
Peanut is a Dart package that automates the deployment of compiled web app output to a GitHub gh-pages branch. It supports both legacy 'pub build' and modern 'pub run build_runner' workflows, streamlining the publishing process for Flutter web applications. Designed for developers who want to host their web apps on GitHub Pages, Peanut handles the build and push steps with minimal configuration. It integrates seamlessly into CI/CD pipelines or local development environments across macOS, Windows, and Linux.
Use cases
- Deploying Flutter web apps to GitHub Pages
- Automating builds and deployments
- Integrating with CI/CD workflows
- Publishing static web content from Dart projects
- Simplifying gh-pages updates after builds
Key features
- Supports pub build and build_runner
- Automates git push to gh-pages
- Cross-platform compatibility
- Minimal setup required
- Works with Flutter web apps
Suitable for
- Flutter web developers
- GitHub Pages users
- CI/CD automation
- Dart project maintainers
- Developers seeking simple deployment
Considerations
- Requires GitHub repository access
- Needs proper git credentials configured
- Not suitable for non-GitHub hosting
- Depends on build_runner for modern workflows
- May require environment-specific setup