Skip to content

Commit 1ae9dd5

Browse files
committed
docs: add goals section and clean up brick READMEs
1 parent 4c300c6 commit 1ae9dd5

File tree

6 files changed

+41
-68
lines changed

6 files changed

+41
-68
lines changed

README.md

Lines changed: 34 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@
44
[![ci][ci_badge]][ci_link]
55
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
66
[![License: MIT][license_badge]][license_link]
7+
[![Powered by Mason](https://img.shields.io/endpoint?url=https%3A%2F%2Ftinyurl.com%2Fmason-badge)](https://github.com/felangel/mason)
78

8-
A fast, minimalistic web framework for Dart 🎯
9+
A fast, minimalistic backend framework for Dart 🎯
910

1011
Developed with 💙 by [Very Good Ventures][very_good_ventures_link] 🦄
1112

@@ -53,6 +54,38 @@ Create a production build which includes a `DockerFile` so that you can deploy a
5354
dart_frog build
5455
```
5556

57+
## Goals 🎯
58+
59+
Dart Frog is built on top of [shelf](https://pub.dev/packages/shelf) and [mason](https://pub.dev/packages/mason) and is inspired by many tools including [remix.run](https://remix.run), [next.js](https://nextjs.org), and [express.js](https://expressjs.com).
60+
61+
The goal of Dart Frog is to help developers effectively build backends in Dart. Currently, Dart Frog is focused on optimizing the process of building backends which aggregate, compose, and normalize data from multiple sources. Dart Frog provides a simple core with a small API surface area in order to reduce the learning curve and ramp-up time for developers. In addition, Dart Frog is intended to help Flutter/Dart developers maximize their productivity by having a unified tech stack that enables sharing tooling, models, and more!
62+
63+
## Feature Set ✨
64+
65+
✅ Hot Reload ⚡️
66+
67+
✅ Dart Dev Tools ⚙️
68+
69+
✅ File System Routing 🚏
70+
71+
✅ Index Routes 🗂
72+
73+
✅ Nested Routes 🪆
74+
75+
✅ Dynamic Routes 🌓
76+
77+
✅ Middleware 🍔
78+
79+
✅ Dependency Injection 💉
80+
81+
✅ Production Builds 👷‍♂️
82+
83+
✅ Docker 🐳
84+
85+
🚧 Generated Dart Client Package 📦
86+
87+
🚧 Generated API Documentation 📔
88+
5689
## Documentation 📝
5790

5891
### Routes 🚏
@@ -206,32 +239,6 @@ In the above test, we're using `package:mocktail` to create a mock `RequestConte
206239

207240
For more information, see the [example][example_link] and our [roadmap][roadmap_link].
208241

209-
## Feature Set ✨
210-
211-
✅ Hot Reload ⚡️
212-
213-
✅ Dart Dev Tools ⚙️
214-
215-
✅ File System Routing 🚏
216-
217-
✅ Index Routes 🗂
218-
219-
✅ Nested Routes 🪆
220-
221-
✅ Dynamic Routes 🌓
222-
223-
✅ Middleware 🍔
224-
225-
✅ Dependency Injection 💉
226-
227-
✅ Production Builds 👷‍♂️
228-
229-
✅ Docker 🐳
230-
231-
🚧 Generated Dart Client Package 📦
232-
233-
🚧 Generated API Documentation 📔
234-
235242
[dart_installation_link]: https://dart.dev/get-dart
236243
[ci_badge]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/dart_frog.yaml/badge.svg
237244
[ci_link]: https://github.com/VeryGoodOpenSource/dart_frog/actions/workflows/dart_frog.yaml

bricks/create_dart_frog/README.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,9 @@
11
# create_dart_frog
22

3-
![Powered by Mason](https://img.shields.io/endpoint?url=https%3A%2F%2Ftinyurl.com%2Fmason-badge)
3+
[![Powered by Mason](https://img.shields.io/endpoint?url=https%3A%2F%2Ftinyurl.com%2Fmason-badge)](https://github.com/felangel/mason)
44

55
A Dart Frog starter app template
66

77
_Generated by [mason][1] 🧱_
88

9-
## Getting Started 🚀
10-
11-
This is a starting point for a new brick.
12-
A few resources to get you started if this is your first brick template:
13-
14-
- [Official Mason Documentation][2]
15-
- [Code generation with Mason Blog][3]
16-
- [Very Good Livestream: Felix Angelov Demos Mason][4]
17-
189
[1]: https://github.com/felangel/mason
19-
[2]: https://github.com/felangel/mason/tree/master/packages/mason_cli#readme
20-
[3]: https://verygood.ventures/blog/code-generation-with-mason
21-
[4]: https://youtu.be/G4PTjA6tpTU

bricks/dart_frog_dev_server/README.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,9 @@
11
# dart_frog_dev_server
22

3-
![Powered by Mason](https://img.shields.io/endpoint?url=https%3A%2F%2Ftinyurl.com%2Fmason-badge)
3+
[![Powered by Mason](https://img.shields.io/endpoint?url=https%3A%2F%2Ftinyurl.com%2Fmason-badge)](https://github.com/felangel/mason)
44

55
A dart_frog dev server
66

77
_Generated by [mason][1] 🧱_
88

9-
## Getting Started 🚀
10-
11-
This is a starting point for a new brick.
12-
A few resources to get you started if this is your first brick template:
13-
14-
- [Official Mason Documentation][2]
15-
- [Code generation with Mason Blog][3]
16-
- [Very Good Livestream: Felix Angelov Demos Mason][4]
17-
189
[1]: https://github.com/felangel/mason
19-
[2]: https://github.com/felangel/mason/tree/master/packages/mason_cli#readme
20-
[3]: https://verygood.ventures/blog/code-generation-with-mason
21-
[4]: https://youtu.be/G4PTjA6tpTU
Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,9 @@
11
# dart_frog_prod_server
22

3-
![Powered by Mason](https://img.shields.io/endpoint?url=https%3A%2F%2Ftinyurl.com%2Fmason-badge)
3+
[![Powered by Mason](https://img.shields.io/endpoint?url=https%3A%2F%2Ftinyurl.com%2Fmason-badge)](https://github.com/felangel/mason)
44

5-
A dart_frog production server
5+
A `dart_frog` production server.
66

77
_Generated by [mason][1] 🧱_
88

9-
## Getting Started 🚀
10-
11-
This is a starting point for a new brick.
12-
A few resources to get you started if this is your first brick template:
13-
14-
- [Official Mason Documentation][2]
15-
- [Code generation with Mason Blog][3]
16-
- [Very Good Livestream: Felix Angelov Demos Mason][4]
17-
189
[1]: https://github.com/felangel/mason
19-
[2]: https://github.com/felangel/mason/tree/master/packages/mason_cli#readme
20-
[3]: https://verygood.ventures/blog/code-generation-with-mason
21-
[4]: https://youtu.be/G4PTjA6tpTU

packages/dart_frog/pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: dart_frog
2-
description: A fast, minimalistic web framework for Dart
2+
description: A fast, minimalistic backend framework for Dart
33
version: 1.0.0+1
44
publish_to: none
55

packages/dart_frog_cli/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
[![ci][ci_badge]][ci_link]
55
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
66
[![License: MIT][license_badge]][license_link]
7+
[![Powered by Mason](https://img.shields.io/endpoint?url=https%3A%2F%2Ftinyurl.com%2Fmason-badge)](https://github.com/felangel/mason)
8+
79

810
The official command line interface for [Dart Frog][dart_frog_link].
911

0 commit comments

Comments
 (0)