Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/release_please.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ on:
push:
branches:
- main
paths:
- "!.github/workflows/site.yaml"
- "!site/**"

jobs:
create_release_pr:
Expand Down
8 changes: 7 additions & 1 deletion site/docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ dart pub global run very_good_cli:very_good <command> <args>

### `very_good create`

Create a very good project in seconds based on the provided template. Each template has a corresponding sub-command. Ex: `very_good create flutter_app` will generate a Flutter starter app.
Create a very good project in seconds based on the provided template. Each template has a corresponding sub-command.

Ex: `very_good create flutter_app my_app` will generate a Flutter starter app named `my_app`.

```sh
Creates a new very good project in the specified directory.
Expand All @@ -62,6 +64,10 @@ Available subcommands:
Run "very_good help" to see global options.
```

:::tip
You can use `.` as the project name to create the project in the current directory. The project will be named with the name of the current directory.
:::

### `very_good packages get`

Get packages in a Dart or Flutter project.
Expand Down
3 changes: 3 additions & 0 deletions site/docs/templates/core.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ very_good create flutter_app my_app --desc "My new Flutter app"

# Create a new Flutter app named my_app with a custom org
very_good create flutter_app my_app --desc "My new Flutter app" --org "com.custom.org"

# Create a new Flutter app named with the name of the current directory
very_good create flutter_app . --desc "My new Flutter app"
```

### Running the Project ⚡
Expand Down
3 changes: 3 additions & 0 deletions site/docs/templates/dart_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ very_good create dart_cli my_dart_cli --desc "My new Dart CLI package"

# Create a new Dart CLI application named my_dart_cli with a custom executable name
very_good create dart_cli my_dart_cli --desc "My new Dart CLI package" --executable-name my_executable_name

# Create a new Dart CLI named with the name of the current directory
very_good create dart_cli . --desc "My new Dart CLI package"
```

[dart_cli]: /img/dart_cli_hero.png
3 changes: 3 additions & 0 deletions site/docs/templates/dart_pkg.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,7 @@ very_good create dart_package my_dart_package --desc "My new Dart package"

# Create a new Dart package named my_dart_package that is publishable
very_good create dart_package my_dart_package --desc "My new Dart package" --publishable

# Create a new Dart package named with the name of the current directory
very_good create dart_package . --desc "My new Dart package"
```
3 changes: 3 additions & 0 deletions site/docs/templates/docs_site.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ This template is powered by [Docusaurus][docusaurus_link] and comes with the fol
```sh
# Create a new docs site named my_docs_site
very_good create docs_site my_docs_site

# Create a new docs site named with the name of the current directory
very_good create docs_site .
```

## Preview 📝
Expand Down
3 changes: 3 additions & 0 deletions site/docs/templates/federated_plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ very_good create flutter_plugin my_flutter_plugin --desc "My new Flutter plugin"
very_good create flutter_plugin my_flutter_plugin --desc "My new Flutter plugin" --platforms=android,ios,web
# or
very_good create flutter_plugin my_flutter_plugin --desc "My new Flutter plugin" --platforms android --platforms ios --platforms web

# Create a new Flutter plugin named with the name of the current directory
very_good create flutter_plugin . --desc "My new Flutter plugin" --platforms android,ios,web
```

[federated_plugin_docs]: https://docs.flutter.dev/development/packages-and-plugins/developing-packages#federated-plugins
3 changes: 3 additions & 0 deletions site/docs/templates/flame_game.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ Read more about this game template [in our blog][blog].
```sh
# Create a new Flame game named my_game
very_good create flame_game my_game --desc "My new Flame game"

# Create a new Flame game named with the name of the current directory
very_good create flame_game . --desc "My new Flame game"
```

[blog]: https://verygood.ventures/blog/generate-a-game-with-our-new-template
Expand Down
3 changes: 3 additions & 0 deletions site/docs/templates/flutter_pkg.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,7 @@ very_good create flutter_package my_flutter_package --desc "My new Flutter packa

# Create a new Flutter package named my_flutter_package that is publishable
very_good create flutter_package my_flutter_package --desc "My new Flutter package" --publishable

# Create a new Flutter package named with the name of the current directory
very_good create flutter_package . --desc "My new Flutter package"
```
3 changes: 3 additions & 0 deletions site/docs/templates/wear.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@ Read more about this app template [in our blog][blog].
```sh
# Create a new Wear OS app named my_wear_app
very_good create flutter_app my_wear_app --desc "My new Wear OS app" --template wear

# Create a new Wear OS named with the name of the current directory
very_good create flutter_app . --desc "My new Wear OS app" --template wear
```

[blog]: https://verygood.ventures/blog/building-wear-os-apps-with-flutter-a-very-good-guide
Expand Down