Skip to content
This repository was archived by the owner on Apr 7, 2026. It is now read-only.

Commit 4822a29

Browse files
docs: Update template metadata for various Dart and Flutter projects (#312)
* docs: Update template metadata for various Dart and Flutter projects - Refined names and descriptions for clarity and consistency across templates. - Enhanced tags to better reflect the functionality and technology stack of each template. - Changed tags to appear in the form they'd be searched i.e. before -> dart-frog, now -> Dart Frog * chore: Pr review
1 parent 7d0a674 commit 4822a29

File tree

10 files changed

+47
-42
lines changed

10 files changed

+47
-42
lines changed

templates/crud_flutter_web/TEMPLATE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
name: Simple Flutter App
3-
description: Building a simple CRUD Flutter Web application that connects to a Shelf Server
4-
tags: ["flutter", "web", "shelf", "api"]
2+
name: Flutter Web App
3+
description: Full-stack Flutter Web app with a Dart backend supporting CRUD operations.
4+
tags: ["Full stack", "Shelf", "Flutter web"]
55
username: Invertase
66
---
77

8-
# Flutter Web + Shelf Server
8+
# Flutter Web App
99

1010
## Overview
1111

templates/crud_rest_api_dartfrog/TEMPLATE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
name: Simple DartFrog Server
3-
description: Building a simple CRUD REST API backend with DartFrog
4-
tags: ["dart", "dart-frog"]
2+
name: Dart Backend (Dart Frog)
3+
description: Structured REST API using DartFrog routing and request handling.
4+
tags: ["API", "Starter", "Dart Frog"]
55
username: Invertase
66
---
77

8-
# Simple DartFrog Server
8+
# Dart Backend (Dart Frog)
99

1010
## Overview
1111

templates/crud_rest_api_shelf/TEMPLATE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
name: Simple Shelf Server
3-
description: Building a simple CRUD REST API backend with Dart Shelf
4-
tags: ["dart", "shelf"]
2+
name: Dart Backend (Shelf)
3+
description: REST API with CRUD Operations built on Dart Shelf.
4+
tags: ["API", "Starter", "Shelf"]
55
username: Invertase
66
---
77

8-
# Simple Shelf Server
8+
# Dart Backend (Shelf)
99

1010
## Overview
1111

templates/dartfrog_github_auth/TEMPLATE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
name: Dart-Frog GitHub Auth
3-
description: GitHub OAuth 2.0 authentication implementation using Dart Frog
4-
tags: ['dart-frog', 'oauth', 'github', 'authentication']
2+
name: GitHub OAuth for Dart Backend
3+
description: GitHub OAuth 2.0 login flow for Dart backends using DartFrog.
4+
tags: ["API", "Authentication", "Dart Frog", "GitHub", "OAuth"]
55
username: Invertase
66
---
77

8-
# GitHub OAuth Authentication with Dart Frog
8+
# GitHub OAuth for Dart Backend
99

1010
## Overview
1111

templates/dartfrog_google_auth/TEMPLATE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
name: Dart-Frog Google Auth
3-
description: Google OAuth 2.0 authentication implementation using Dart Frog
4-
tags: ['dart-frog', 'oauth', 'google', 'authentication']
2+
name: Google OAuth for Dart Backend
3+
description: Google OAuth 2.0 authentication flow for Dart backends with profile access.
4+
tags: ["API", "Authentication", "Dart Frog", "Google", "OAuth"]
55
username: Invertase
66
---
77

8-
# Google OAuth Authentication with Dart Frog
8+
# Google OAuth for Dart Backend
99

1010
## Overview
1111

templates/dartfrog_jwt_auth/TEMPLATE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
name: Dart-Frog JWT Auth
3-
description: Building a simple Dart-Frog Backend with JWT Auth
4-
tags: ["dart-frog", "jwt", "authentication"]
2+
name: Dart Backend with Authentication (Dart Frog)
3+
description: JWT authentication for Dart backends with protected routes.
4+
tags: ["API", "Authentication", "Dart Frog", "JWT"]
55
username: Invertase
66
---
77

8-
# Dart-Frog JWT Auth
8+
# Dart Backend with Authentication (Dart Frog)
99

1010
## Overview
1111

templates/ffi_hello_world/TEMPLATE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
name: Dart + Rust FFI
3-
description: Building a simple Dart+FFI API backend
4-
tags: ["dart", "dart-ffi"]
2+
name: Dart & Rust FFI Backend
3+
description: Dart backend integrating Rust via FFI for native performance.
4+
tags: ["API", "Shelf", "FFI", "Rust"]
55
username: Invertase
66
---
77

8-
# Dart + Rust FFI
8+
# Dart & Rust FFI Backend
99

1010
## Overview
1111

templates/notes_api_dartfrog_globedb/TEMPLATE.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
name: Notes API with Dart Frog & Globe DB
3-
description: Build a CRUD API for notes using Dart Frog and Globe's serverless SQLite database
4-
tags: ["dart", "dart-frog", "globedb", "drift"]
2+
name: Dart Database
3+
description: Notes CRUD API using DartFrog and Globe's serverless SQLite database.
4+
tags: ["Full stack", "Dart Frog", "Database", "Globe DB", "Drift"]
55
username: Invertase
66
---
77

@@ -65,30 +65,35 @@ $ dart_frog dev --port 8080
6565
### API Endpoints
6666

6767
#### List All Notes
68+
6869
```bash
6970
curl http://localhost:8080/notes
7071
```
7172

7273
#### Create a Note
74+
7375
```bash
7476
curl -X POST -H "Content-Type: application/json" \
7577
-d '{"title": "My First Note", "content": "Hello Globe DB!"}' \
7678
http://localhost:8080/notes
7779
```
7880

7981
#### Get a Specific Note
82+
8083
```bash
8184
curl http://localhost:8080/notes/1
8285
```
8386

8487
#### Update a Note
88+
8589
```bash
8690
curl -X PATCH -H "Content-Type: application/json" \
8791
-d '{"content": "Updated content"}' \
8892
http://localhost:8080/notes/1
8993
```
9094

9195
#### Delete a Note
96+
9297
```bash
9398
curl -X DELETE http://localhost:8080/notes/1
9499
```
@@ -106,11 +111,13 @@ The template includes a simple notes table with the following structure:
106111
#### Deploy to Globe
107112

108113
1. Make sure you're logged in to Globe CLI:
114+
109115
```shell
110116
$ globe login
111117
```
112118

113119
2. Deploy your API:
120+
114121
```shell
115122
$ globe deploy
116123
```
@@ -162,5 +169,3 @@ notes_api_dartfrog_globedb/
162169
- **Add Error Handling**: Enhance error responses
163170
- **Add Tests**: Write unit and integration tests
164171
- **Add Documentation**: Generate API documentation
165-
166-

templates/notes_app_shelf/TEMPLATE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
name: Flutter + Firebase Auth + Shelf Backend
3-
description: Build a Notes App using Flutter Web, Firebase Auth and a custom backend using Shelf.
4-
tags: ["firebase", "shelf", "flutter", "firestore"]
2+
name: Flutter Web Notes App
3+
description: Full-stack Notes app built with Flutter Web, Firebase Auth, and a Dart Shelf backend.
4+
tags: ["Full stack", "Authentication", "Shelf", "Flutter web", "Firebase Auth"]
55
username: Invertase
66
---
77

8-
# Flutter + Firebase Auth + Shelf Backend
8+
# Flutter Web Notes App
99

1010
## Overview
1111

12-
Build a Simple Notes App using Flutter Web, Firebase Auth and Dart for our backend.
12+
Build a Full-stack Notes App using Flutter Web, Firebase Auth and Dart for our backend.
1313

1414
### Getting Started
1515

templates/shelf_jwt_auth/TEMPLATE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
name: Shelf JWT Auth
3-
description: Building a simple Shelf Backend with JWT Auth
4-
tags: ["shelf", "jwt", "authentication"]
2+
name: Dart Backend with Authentication (Shelf)
3+
description: Dart Shelf backend with JWT authentication and protected routes.
4+
tags: ["API", "Authentication", "Shelf", "JWT"]
55
username: Invertase
66
---
77

8-
# Shelf JWT Auth
8+
# Dart Backend with Authentication (Shelf)
99

1010
## Overview
1111

0 commit comments

Comments
 (0)