Skip to content

Commit 1f1e166

Browse files
committed
chore: register API templates in docs and smoke tests
1 parent 6abba0c commit 1f1e166

2 files changed

Lines changed: 17 additions & 6 deletions

File tree

.github/workflows/template-smoke.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ jobs:
1717
fail-fast: false
1818
matrix:
1919
include:
20+
- template: bun/api
21+
runtime: bun
22+
install: bun install
23+
verify: bun run verify
2024
- template: bun/cli
2125
runtime: bun
2226
install: bun install
@@ -25,6 +29,10 @@ jobs:
2529
runtime: bun
2630
install: bun install
2731
verify: bun run verify
32+
- template: node/api
33+
runtime: node
34+
install: npm ci
35+
verify: npm run verify
2836
- template: node/cli
2937
runtime: node
3038
install: npm ci

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,17 @@ npx giget gh:bentruyman/templates/<template> <project-name>
1111
```
1212

1313
The Node templates require Node.js 24 or newer.
14+
The API templates also require Docker with Compose support for local PostgreSQL.
1415

1516
## Available Templates
1617

17-
| Template | Description | Command |
18-
| -------------------- | ---------------------------------------------- | -------------------------------------------------- |
19-
| [bun/cli](./bun/cli) | Bun CLI with TypeScript, Husky, and release-it | `npx giget gh:bentruyman/templates/bun/cli my-cli` |
20-
| [bun/lib](./bun/lib) | Bun library with TypeScript, Husky, and release-it | `npx giget gh:bentruyman/templates/bun/lib my-lib` |
21-
| [node/cli](./node/cli) | Node.js CLI with TypeScript, Vitest, Husky, and release-it | `npx giget gh:bentruyman/templates/node/cli my-cli` |
22-
| [node/lib](./node/lib) | Node.js library with TypeScript, Vitest, Husky, and release-it | `npx giget gh:bentruyman/templates/node/lib my-lib` |
18+
| Template | Description | Command |
19+
| ---------------------- | ------------------------------------------------------------ | ---------------------------------------------------- |
20+
| [bun/api](./bun/api) | Bun API with Hono, Drizzle, PostgreSQL, and Docker Compose | `npx giget gh:bentruyman/templates/bun/api my-api` |
21+
| [bun/cli](./bun/cli) | Bun CLI with TypeScript, Husky, and release-it | `npx giget gh:bentruyman/templates/bun/cli my-cli` |
22+
| [bun/lib](./bun/lib) | Bun library with TypeScript, Husky, and release-it | `npx giget gh:bentruyman/templates/bun/lib my-lib` |
23+
| [node/api](./node/api) | Node.js API with Hono, Drizzle, PostgreSQL, and Docker Compose | `npx giget gh:bentruyman/templates/node/api my-api` |
24+
| [node/cli](./node/cli) | Node.js CLI with TypeScript, Vitest, Husky, and release-it | `npx giget gh:bentruyman/templates/node/cli my-cli` |
25+
| [node/lib](./node/lib) | Node.js library with TypeScript, Vitest, Husky, and release-it | `npx giget gh:bentruyman/templates/node/lib my-lib` |
2326

2427
See each template's README for detailed usage instructions.

0 commit comments

Comments
 (0)