mirror of
https://github.com/flutter/samples.git
synced 2025-11-08 13:58:47 +00:00
add deployment documentation to web/ directory (#164)
* add deployment documentation to web/ directory * add clarification * formatting
This commit is contained in:
@@ -23,6 +23,20 @@ Web support is available as a technical preview and is only available in the
|
||||
|
||||
You should see a message printing the URL to access: `http://localhost:8080`
|
||||
|
||||
## Deploying to GitHub Pages
|
||||
|
||||
This project uses [peanut][peanut] to build the samples and commit the output
|
||||
to the gh-pages branch. To deploy, run these commands in the `web/` directory:
|
||||
|
||||
```console
|
||||
$ flutter pub global activate peanut
|
||||
$ flutter pub global run peanut
|
||||
$ git push origin gh-pages:gh-pages
|
||||
```
|
||||
|
||||
Note: `flutter packages get` must be run in each sample before running `peanut`.
|
||||
|
||||
[web]: https://flutter.dev/web
|
||||
[samples]: https://flutter.github.io/samples/
|
||||
[peanut]: https://github.com/kevmoo/peanut.dart
|
||||
|
||||
|
||||
Reference in New Issue
Block a user