Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
2 changes: 1 addition & 1 deletion .github/dependabot.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ updates:
interval: "weekly"
ignore:
# Updating @types/vscode requires unnecessarily bumping the VS Code engine version, see:
# https://github.com/VeryGoodOpenSource/dart_frog/issues/1033
# https://github.com/dart-frog-dev/dart_frog/issues/1033
- dependency-name: "@types/vscode"
- package-ecosystem: "pub"
directory: "/bricks/create_dart_frog/hooks"
Expand Down
26 changes: 13 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ This is a mono repo, a repository that includes more than one individual project

The contents of the mono repo is divided into the following directories:

- [`tool/`](https://github.com/VeryGoodOpenSource/dart_frog/tree/main/tool): contains internal operation scripts
- [`assets/`](https://github.com/VeryGoodOpenSource/dart_frog/tree/main/assets): images to embed into READMEs
- [`docs/`](https://github.com/VeryGoodOpenSource/dart_frog/tree/main/docs): source code for the [docs site][dart_frog_site].
- [`examples/`](https://github.com/VeryGoodOpenSource/dart_frog/tree/main/examples): example projects of some of the several usages of Dart Frog
- [`extensions/`](https://github.com/VeryGoodOpenSource/dart_frog/tree/main/extensions): Integrations with IDEs such as VS Code.
- [`bricks/`](https://github.com/VeryGoodOpenSource/dart_frog/tree/main/bricks): Internal mason bricks used by [dart_frog_cli][dart_frog_cli_link] to perform tasks such as creating new projects, starting a dev server, and building a prod server.
- [`packages/`](https://github.com/VeryGoodOpenSource/dart_frog/tree/main/packages): The source code of the packages that constitute the Dart Frog suite (`dart_frog_cli`, `dart_frog` and `dart_frog_gen`) as well as companion packages (such as `dart_frog_web_socket`).
- [`tool/`](https://github.com/dart-frog-dev/dart_frog/tree/main/tool): contains internal operation scripts
- [`assets/`](https://github.com/dart-frog-dev/dart_frog/tree/main/assets): images to embed into READMEs
- [`docs/`](https://github.com/dart-frog-dev/dart_frog/tree/main/docs): source code for the [docs site][dart_frog_site].
- [`examples/`](https://github.com/dart-frog-dev/dart_frog/tree/main/examples): example projects of some of the several usages of Dart Frog
- [`extensions/`](https://github.com/dart-frog-dev/dart_frog/tree/main/extensions): Integrations with IDEs such as VS Code.
- [`bricks/`](https://github.com/dart-frog-dev/dart_frog/tree/main/bricks): Internal mason bricks used by [dart_frog_cli][dart_frog_cli_link] to perform tasks such as creating new projects, starting a dev server, and building a prod server.
- [`packages/`](https://github.com/dart-frog-dev/dart_frog/tree/main/packages): The source code of the packages that constitute the Dart Frog suite (`dart_frog_cli`, `dart_frog` and `dart_frog_gen`) as well as companion packages (such as `dart_frog_web_socket`).

Some of the included projects have more specific instructions on contribution. In these cases, the project root may include a `CONTRIBUTING.md` file with such instructions.

Expand Down Expand Up @@ -53,7 +53,7 @@ accepted.

Prerequisites:

- Install a valid [Dart SDK](https://dart.dev/get-dart) in your local environment, it should be compatible with the latest version of [Dart Frog CLI](https://github.com/VeryGoodOpenSource/dart_frog/blob/main/packages/dart_frog_cli/pubspec.yaml). If you have Flutter installed, you likely have a valid Dart SDK version already installed.
- Install a valid [Dart SDK](https://dart.dev/get-dart) in your local environment, it should be compatible with the latest version of [Dart Frog CLI](https://github.com/dart-frog-dev/dart_frog/blob/main/packages/dart_frog_cli/pubspec.yaml). If you have Flutter installed, you likely have a valid Dart SDK version already installed.
- [Mason CLI][mason_install_link] (to run and test the `bricks`);
- [Node.js][node_js_dowload_link], for working with the VS Code extension or the documentation website. Refer to their CONTRIBUTING files for further installation requirements.
- Capability to run shell scripts (for the scripts under `tool/`).
Expand Down Expand Up @@ -91,7 +91,7 @@ git fetch
git status
```

2. Ensure the [GitHub pipeline](https://github.com/VeryGoodOpenSource/dart_frog/actions) is green (has passed successfully) for your given package.
2. Ensure the [GitHub pipeline](https://github.com/dart-frog-dev/dart_frog/actions) is green (has passed successfully) for your given package.

3. Run the script under `tool/release_ready.sh` within the package root repository and the desired new version.

Expand All @@ -106,18 +106,18 @@ The above example will: update the version of `<package>` to `<version>`, update

5. Commit, push and open a pull request from the new release branch.

6. Once merged, create a [release on GitHub][github_release_link]. The [publish workflow](https://github.com/VeryGoodOpenSource/dart_frog/blob/main/.github/workflows/publish.yaml) should take care of publishing the new version on the appropriate package manager.
6. Once merged, create a [release on GitHub][github_release_link]. The [publish workflow](https://github.com/dart-frog-dev/dart_frog/blob/main/.github/workflows/publish.yaml) should take care of publishing the new version on the appropriate package manager.

7. Open follow-up pull requests updating this package usage in any other Dart Frog package that depends on this new release.

[conventional_commits_link]: https://www.conventionalcommits.org/en/v1.0.0
[bug_report_link]: https://github.com/VeryGoodOpenSource/dart_frog/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=fix%3A+
[issue_creation_link]: https://github.com/VeryGoodOpenSource/dart_frog/issues/new/choose
[bug_report_link]: https://github.com/dart-frog-dev/dart_frog/issues/new?assignees=&labels=bug&projects=&template=bug_report.md&title=fix%3A+
[issue_creation_link]: https://github.com/dart-frog-dev/dart_frog/issues/new/choose
[very_good_ventures_link]: https://verygood.ventures
[dart_frog_site]: https://dart-frog.dev/
[dart_frog_cli_link]: https://pub.dev/packages/dart_frog_cli
[node_js_dowload_link]: https://nodejs.org/pt-br/download
[mason_install_link]: https://docs.brickhub.dev/installing/
[dart_standalone_link]: https://dart.dev/get-dart
[dart_on_flutter_link]: https://docs.flutter.dev/get-started/install
[github_release_link]: https://github.com/VeryGoodOpenSource/dart_frog/releases
[github_release_link]: https://github.com/dart-frog-dev/dart_frog/releases
31 changes: 15 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,13 @@ For official documentation, please visit https://dart-frog.dev.

## Packages 📦

| Package | Pub |
| --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| [dart_frog](https://github.com/verygoodopensource/dart_frog/tree/main/packages/dart_frog) | [![pub package](https://img.shields.io/pub/v/dart_frog.svg)](https://pub.dev/packages/dart_frog) |
| [dart_frog_gen](https://github.com/verygoodopensource/dart_frog/tree/main/packages/dart_frog_gen) | [![pub package](https://img.shields.io/pub/v/dart_frog_gen.svg)](https://pub.dev/packages/dart_frog_gen) |
| [dart_frog_cli](https://github.com/verygoodopensource/dart_frog/tree/main/packages/dart_frog_cli) | [![pub package](https://img.shields.io/pub/v/dart_frog_cli.svg)](https://pub.dev/packages/dart_frog_cli) |
| [dart_frog_web_socket](https://github.com/verygoodopensource/dart_frog/tree/main/packages/dart_frog_web_socket) | [![pub package](https://img.shields.io/pub/v/dart_frog_web_socket.svg)](https://pub.dev/packages/dart_frog_web_socket) |
| [dart_frog_auth](https://github.com/verygoodopensource/dart_frog/tree/main/packages/dart_frog_auth) | [![pub package](https://img.shields.io/pub/v/dart_frog_auth.svg)](https://pub.dev/packages/dart_frog_auth) |

| Package | Pub |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| [dart_frog](https://github.com/dart-frog-dev/dart_frog/tree/main/packages/dart_frog) | [![pub package](https://img.shields.io/pub/v/dart_frog.svg)](https://pub.dev/packages/dart_frog) |
| [dart_frog_gen](https://github.com/dart-frog-dev/dart_frog/tree/main/packages/dart_frog_gen) | [![pub package](https://img.shields.io/pub/v/dart_frog_gen.svg)](https://pub.dev/packages/dart_frog_gen) |
| [dart_frog_cli](https://github.com/dart-frog-dev/dart_frog/tree/main/packages/dart_frog_cli) | [![pub package](https://img.shields.io/pub/v/dart_frog_cli.svg)](https://pub.dev/packages/dart_frog_cli) |
| [dart_frog_web_socket](https://github.com/dart-frog-dev/dart_frog/tree/main/packages/dart_frog_web_socket) | [![pub package](https://img.shields.io/pub/v/dart_frog_web_socket.svg)](https://pub.dev/packages/dart_frog_web_socket) |
| [dart_frog_auth](https://github.com/dart-frog-dev/dart_frog/tree/main/packages/dart_frog_auth) | [![pub package](https://img.shields.io/pub/v/dart_frog_auth.svg)](https://pub.dev/packages/dart_frog_auth) |

## Quick Start 🚀

Expand Down Expand Up @@ -93,16 +92,16 @@ Dart Frog provides a simple core with a small API surface area in order to reduc
- [VS Code](https://marketplace.visualstudio.com/items?itemName=VeryGoodVentures.dart-frog): extends VS Code with support for Dart Frog and provides tools for effectively managing Dart Frog projects within VS Code.

[dart_installation_link]: https://dart.dev/get-dart
[ci_badge]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/main.yaml/badge.svg
[ci_link]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/main.yaml
[coverage_badge]: https://raw.githubusercontent.com/VeryGoodOpenSource/dart_frog/main/packages/dart_frog/coverage_badge.svg
[dart_frog_link_dark]: https://github.com/verygoodopensource/dart_frog#gh-dark-mode-only
[dart_frog_link_light]: https://github.com/verygoodopensource/dart_frog#gh-light-mode-only
[ci_badge]: https://github.com/dart-frog-dev/dart_frog/actions/workflows/main.yaml/badge.svg
[ci_link]: https://github.com/dart-frog-dev/dart_frog/actions/workflows/main.yaml
[credits_link]: https://github.com/dart-frog-dev/dart_frog/blob/main/CREDITS.md#acknowledgments
[coverage_badge]: https://raw.githubusercontent.com/dart-frog-dev/dart_frog/main/packages/dart_frog/coverage_badge.svg
[dart_frog_link_dark]: https://github.com/dart-frog-dev/dart_frog#gh-dark-mode-only
[dart_frog_link_light]: https://github.com/dart-frog-dev/dart_frog#gh-light-mode-only
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
[license_link]: https://opensource.org/licenses/MIT
[logo_black]: https://raw.githubusercontent.com/VeryGoodOpenSource/dart_frog/main/assets/dart_frog_logo_black.png#gh-light-mode-only
[logo_white]: https://raw.githubusercontent.com/VeryGoodOpenSource/dart_frog/main/assets/dart_frog_logo_white.png#gh-dark-mode-only
[logo_black]: https://raw.githubusercontent.com/dart-frog-dev/dart_frog/main/assets/dart_frog_logo_black.png#gh-light-mode-only
[logo_white]: https://raw.githubusercontent.com/dart-frog-dev/dart_frog/main/assets/dart_frog_logo_white.png#gh-dark-mode-only
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
[very_good_ventures_link]: https://verygood.ventures
[credits_link]: ./CREDITS.md#acknowledgments
Binary file added assets/dart_frog.png
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added this to restore the broken README header images in each of the packages

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/src/content/docs/advanced/daemon.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ messages.
:::note

For a concrete sample of how to interact with the daemon via `stdio`, see the
[end-to-end tests](https://github.com/VeryGoodOpenSource/dart_frog/tree/main/packages/dart_frog_cli/e2e/test/daemon).
[end-to-end tests](https://github.com/dart-frog-dev/dart_frog/tree/main/packages/dart_frog_cli/e2e/test/daemon).

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/src/content/docs/advanced/debugging.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ If you are interested in an extension for Android Studio or OpenVSX there are
some open issues you can follow to learn more about it:

- **Android Studio**
[#1326](https://github.com/VeryGoodOpenSource/dart_frog/issues/1326)
- **OpenVSX** [#907](https://github.com/VeryGoodOpenSource/dart_frog/issues/907)
[#1326](https://github.com/dart-frog-dev/dart_frog/issues/1326)
- **OpenVSX** [#907](https://github.com/dart-frog-dev/dart_frog/issues/907)

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/basics/dependency-injection.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ Handler middleware(Handler handler) {
:::note

Right now, there is an issue about this
[fix: Improve dependency injection order #745](https://github.com/VeryGoodOpenSource/dart_frog/issues/745)
[fix: Improve dependency injection order #745](https://github.com/dart-frog-dev/dart_frog/issues/745)
because some other DI frameworks are working top to bottom and dart_frog is
bottom to top.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/tutorials/counter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -265,4 +265,4 @@ You have requested this route 2 time(s).
only maintained in memory. :::

🎉 Congrats, you've created a `counter` application using Dart Frog. View the
[full source code](https://github.com/VeryGoodOpenSource/dart_frog/tree/main/examples/counter).
[full source code](https://github.com/dart-frog-dev/dart_frog/tree/main/examples/counter).
2 changes: 1 addition & 1 deletion docs/src/content/docs/tutorials/todos.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -775,4 +775,4 @@ middleware that look similar to:
:::

🎉 Congrats, you've created a `todos` application using Dart Frog. View the
[full source code](https://github.com/VeryGoodOpenSource/dart_frog/tree/main/examples/todos).
[full source code](https://github.com/dart-frog-dev/dart_frog/tree/main/examples/todos).
2 changes: 1 addition & 1 deletion docs/src/content/docs/tutorials/web-socket-counter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -483,4 +483,4 @@ only maintained in memory.

🎉 Congrats, you've created a real-time counter application using Dart Frog.
View the
[full source code](https://github.com/VeryGoodOpenSource/dart_frog/tree/main/examples/web_socket_counter).
[full source code](https://github.com/dart-frog-dev/dart_frog/tree/main/examples/web_socket_counter).
Loading
Loading