Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kevmoo/peanut.dart
Easily build and deploy your Dart web app to GitHub pages
https://github.com/kevmoo/peanut.dart
dart flutter
Last synced: about 2 months ago
JSON representation
Easily build and deploy your Dart web app to GitHub pages
- Host: GitHub
- URL: https://github.com/kevmoo/peanut.dart
- Owner: kevmoo
- License: bsd-3-clause
- Created: 2015-04-07T16:15:05.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-06-01T18:09:16.000Z (4 months ago)
- Last Synced: 2024-06-24T01:40:41.531Z (3 months ago)
- Topics: dart, flutter
- Language: Dart
- Homepage: https://pub.dev/packages/peanut
- Size: 924 KB
- Stars: 210
- Watchers: 5
- Forks: 29
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pub.dev/packages/peanut)
[](https://github.com/kevmoo/peanut.dart/actions?query=workflow%3ACI+branch%3Amaster)
Run `flutter build web` or `dart pub run build_runner build` and put the output
in another branch. An easy way to update [gh-pages](https://pages.github.com/).
## Install
```console
$ dart pub global activate peanut
```
_or_
```console
$ flutter pub global activate peanut
```
## Run
```console
$ peanut
```
_or_
```console
$ flutter pub global run peanut
```
This will build your project into a temporary directory, and then it will update
the local `gh-pages` branch with the build output.
Read more about `peanut` in
[this article](https://medium.com/@kevmoo/show-off-your-flutter-dart-web-app-with-peanut-c0307f2b733c).
## Options
```console
$ peanut --help
Usage: peanut []
Arguments:
-d, --directories The directories that should be built.
(defaults to "web")
-b, --branch The git branch where the built content should
be committed.
(defaults to "gh-pages")
-c, --build-config The configuration to use when running
`build_runner`.
--[no-]release Flutter: enabled passes `--release`, otherwise
passes `--profile`.
Other: enabled passes `--release`, otherwise
passes `--no-release`.
(defaults to on)
-m, --message (defaults to "Built ")
--[no-]source-branch-info Includes the name of the source branch and SHA
in the commit message
(defaults to on)
--post-build-dart-script Optional Dart script to run after all builds
have completed, but before files are committed
to the repository.
--builder-options Builder options YAML or a path to a file
containing builder options YAML.
See the README for details.
--[no-]verbose Print more details when running.
--dry-run Verifies configuration and prints commands that
would be executed, but does not do any work.
--web-renderer The renderer implementation to use when
building for the web. Flutter web only.
[auto] (default) Use the HTML renderer on mobile devices, and
CanvasKit on desktop devices.
[canvaskit] This renderer uses WebGL and WebAssembly to
render graphics.
[html] This renderer uses a combination of HTML, CSS,
SVG, 2D Canvas, and WebGL.
--extra-args Extra arguments to provide to the target CLI
within a single string.
Examples:
--extra-args "--dart-define TEST_VAR=123"
--extra-args "--dart-define --base-href=/base/"
-h, --help Prints usage information.
--version Print the current version.
```
## Configuration file
`peanut` also supports a configuration file. Convenient if you have one-off
settings you'd rather not type every time you deploy.
The `peanut.yaml` from this repository:
```yaml
# Configuration for https://pub.dev/packages/peanut
directories:
- example
```
## Examples
- https://github.com/dart-lang/sample-pop_pop_win/
- Output: https://dart-lang.github.io/sample-pop_pop_win/
- No custom configuration.
- https://github.com/kevmoo/pubviz
- Output: http://kevmoo.github.io/pubviz/
- Custom `peanut.yaml` file to specify `builder-options` and `example` as the
source directory.
- https://github.com/flutter/samples/tree/master/web
- Output: https://flutter.github.io/samples/
- Custom `peanut.yaml` file to specify `builder-options`, multiple source
directories, and a custom post-build file.
- https://github.com/kevmoo/vote.dart/tree/master/vote_demo
## Git tricks
The easiest way to push your `gh-pages` branch to github (without switching from
your working branch) is:
```console
$ git push origin --set-upstream gh-pages
```
To create (or update) your local `gh-pages` branch to match what's on the
server.
```console
$ git update-ref refs/heads/gh-pages origin/gh-pages
```
This is also useful if you want to undo a `peanut` run.
## Publishing automation
For information about our publishing automation and release process, see
https://github.com/dart-lang/ecosystem/wiki/Publishing-automation.