Skip to content

Commit a1e8d57

Browse files
NleaNele Lea Uhlemannbrettimus
authored
Example Folder Readme Update (#58)
* Example Folder Readme: - fix listing inside the detail - include link to awesome honc - remove external projects from the list Remove awesome list from repo * Remove package-lock.json files * Ignore all package-lock.json files * Remove vscode settings * Ignore .vscode * Pepper in more references to awesome-honc --------- Co-authored-by: Nele Lea Uhlemann <[email protected]> Co-authored-by: Brett Beutell <[email protected]>
1 parent 74fa283 commit a1e8d57

File tree

10 files changed

+32
-32
lines changed

10 files changed

+32
-32
lines changed

.gitignore

+6
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,15 @@ node_modules
33
# Ignore package-lock.json files in templates
44
templates/**/package-lock.json
55

6+
# Ignore package-lock.json files in examples
7+
examples/**/package-lock.json
8+
69
# Ignore test apps
710
cli/test-apps/**
811
!cli/test-apps/.gitkeep
912

1013
# Ignore macOS DS_Store files
1114
.DS_Store
15+
16+
# Ignore VSCode settings
17+
.vscode/

awesome-honc.md

-14
This file was deleted.

cli/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@
2020
🪿 **[Drizzle](https://orm.drizzle.team/)** as the ORM and migrations manager
2121
🪿 **[Cloudflare](https://workers.cloudflare.com/)** Workers for deployment hosting
2222

23+
24+
> 📚 For more examples and templates, check out the [Awesome Honc](https://github.com/fiberplane/awesome-honc) repository.
25+
2326
## Quickstart
2427

2528
To get started run the following command:
@@ -92,4 +95,4 @@ This file can be kept in version control. From [the Neon docs](https://neon.tech
9295

9396
See the [examples](/examples) folder for some sample APIs.
9497

95-
We have an [awesome HONC list](https://github.com/fiberplane/create-honc-app/blob/main/awesome-honc.md) with further guides, use cases and examples.
98+
We have an [Awesome HONC repository](https://github.com/fiberplane/awesome-honc) with further guides, use cases and examples.

examples/README.md

+10-17
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This directory contains example projects built with the HONC stack, showcasing different use cases, patterns, and integrations.
44

5+
> 📚 For more examples and templates, check out the [Awesome Honc](https://github.com/fiberplane/awesome-honc) repository.
6+
57
## Projects
68

79
### 🎯 [Placegoose](./placegoose)
@@ -12,6 +14,7 @@ A mock REST API service providing goose-themed data, similar to JSON Placeholder
1214

1315
<details>
1416
<summary>Integrations</summary>
17+
1518
- Cloudflare D1 for data storage
1619
- Cloudflare Asset Bindings for Workers
1720
- UI: Markdown rendered with Remark
@@ -25,6 +28,7 @@ A RAG (Retrieval Augmented Generation) example that uses Cloudflare docs as a kn
2528

2629
<details>
2730
<summary>Integrations</summary>
31+
2832
- Neon serverless Postgres for data storage and vector search
2933
- OpenAI for embeddings generation
3034
- UI: SSR with hono/jsx and Fiberplane's "ascuii" SSR ui components
@@ -37,6 +41,7 @@ A serverless monitoring application that tracks website uptime. Features configu
3741

3842
<details>
3943
<summary>Integrations</summary>
44+
4045
- Cloudflare D1 for data storage
4146
- Cloudflare Durable Objects for serverless state
4247
- UI: SSR with hono/jsx
@@ -45,30 +50,15 @@ A serverless monitoring application that tracks website uptime. Features configu
4550
### 🤖 Telegram Bot
4651
A personal AI assistant agent that can manage your schedule, events and calendars.
4752
- Check out [the GitHub repo](https://github.com/MonsterDeveloper/www-berlin-feb-2025)
48-
49-
### 🎁 Gift Card Generator
50-
A gift card creator that generates gift cards.
51-
- Check out [the GitHub repo](https://github.com/Alwurts/honc-slide-generator)
52-
53-
### 💱 HONC Currency converter
54-
A currency converter.
55-
- Check out [the GitHub repo](GitHub.com/JBlezi/honc-currency-converter)
56-
57-
### 🍽️ Recipe AI Assistant
58-
An app for recording recipes.
59-
- Check out [the GitHub repo](https://github.com/justArale/recipe-ai-assistant)
60-
61-
### 😂 Meme Generator
62-
A meme generator.
63-
- Check out [the GitHub repo](https://github.com/whereissam/meme-generator)
64-
53+
6554
### 🎨 [Honcanator](./honcanator)
6655
An AI-powered goose image generator that creates comic/anime style goose images using Cloudflare AI. Stores images in R2 and metadata in Neon Postgres.
6756

6857
- Blog post: https://fiberplane.com/blog/ai-goose-generator/
6958

7059
<details>
7160
<summary>Integrations</summary>
61+
7262
- Neon serverless Postgres for relational data storage
7363
- Cloudflare R2 for blob storage
7464
- Cloudflare AI for image generation (Flux-1-Schnell)
@@ -80,6 +70,7 @@ A Made-for-TV Christmas Movie idea geneator using `llama3.3-70b-instruct` and To
8070

8171
<details>
8272
<summary>Integrations</summary>
73+
8374
- Cloudflare D1 to store movie ideas
8475
- Together AI to generate movie ideas
8576
</details>
@@ -90,6 +81,7 @@ A GitHub PR review bot that provides "goosey" code reviews using Claude. Built w
9081

9182
<details>
9283
<summary>Integrations</summary>
84+
9385
- GitHub Octokit to handle webhooks and pull requests
9486
- Claude (Anthropic) to provide code reviews
9587
</details>
@@ -101,6 +93,7 @@ A web app that generates (terrible) goose-themed jokes using Cloudflare AI. Stor
10193

10294
<details>
10395
<summary>Integrations</summary>
96+
10497
- Neon serverless Postgres for data storage
10598
- Cloudflare AI (Llama-3.1-8B-Instruct)
10699
</details>

templates/base-openapi/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ This is a project created with the `create-honc-app` template.
44

55
Learn more about the HONC stack on the [website](https://honc.dev) or the main [repo](https://github.com/fiberplane/create-honc-app).
66

7+
> There is also an [Awesome HONC collection](https://github.com/fiberplane/awesome-honc) with further guides, use cases and examples.
8+
79
This template uses a Neon database and [a version of Hono](https://hono.dev/examples/zod-openapi) that can generate an OpenAPI spec from your code. The OpenAPI spec is served from the route `/openapi.json`. To explore your API interactively, run `npm run dev` and go to `http://localhost:8787/fp`.
810

911
### Getting started

templates/base-supa-openapi/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ This is a project created with the `create-honc-app` template.
44

55
Learn more about the HONC stack on the [website](https://honc.dev) or the main [repo](https://github.com/fiberplane/create-honc-app).
66

7+
There is also an [Awesome HONC collection](https://github.com/fiberplane/awesome-honc) with further guides, use cases and examples.
8+
79
### Getting started
810

911
Make sure you have Supabase set up and configured with your database. Create a .dev.vars file with the `DATABASE_URL` key and value (see: `.dev.vars.example`).

templates/base-supa/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ This is a project created with the `create-honc-app` template.
44

55
Learn more about the HONC stack on the [website](https://honc.dev) or the main [repo](https://github.com/fiberplane/create-honc-app).
66

7+
> There is also an [Awesome HONC collection](https://github.com/fiberplane/awesome-honc) with further guides, use cases and examples.
8+
79
This template uses Drizzle to query a Supabase (postgres) database. It also has [a version of Hono](https://hono.dev/examples/zod-openapi) that can generate an OpenAPI spec from your code. The OpenAPI spec is served from the route `/openapi.json`. To explore your API interactively, run `npm run dev` and go to `http://localhost:8787/fp`.
810

911
### Getting started

templates/base/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ This is a project created with the `create-honc-app` template.
44

55
Learn more about the HONC stack on the [website](https://honc.dev) or the main [repo](https://github.com/fiberplane/create-honc-app).
66

7+
There is also an [Awesome HONC collection](https://github.com/fiberplane/awesome-honc) with further guides, use cases and examples.
8+
79
### Getting started
810

911
Make sure you have Neon set up and configured with your database. Create a .dev.vars file with the `DATABASE_URL` key and value (see: `.dev.vars.example`).

templates/d1-openapi/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ This is a project created with the `create-honc-app` template.
44

55
Learn more about the HONC stack on the [website](https://honc.dev) or the main [repo](https://github.com/fiberplane/create-honc-app).
66

7+
> There is also an [Awesome HONC collection](https://github.com/fiberplane/awesome-honc) with further guides, use cases and examples.
8+
79
This template uses a Cloudflare D1 (sqlite) database. It also has [a version of Hono](https://hono.dev/examples/zod-openapi) that can generate an OpenAPI spec from your code. The OpenAPI spec is served from the route `/openapi.json`. To explore your API interactively, run `npm run dev` and go to `http://localhost:8787/fp`.
810

911
### Getting started

templates/d1/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ This is a project created with the `create-honc-app` template.
44

55
Learn more about the HONC stack on the [website](https://honc.dev) or the main [repo](https://github.com/fiberplane/create-honc-app).
66

7+
There is also an [Awesome HONC collection](https://github.com/fiberplane/awesome-honc) with further guides, use cases and examples.
8+
79
### Getting started
810
[D1](https://developers.cloudflare.com/d1/) is Cloudflare's serverless SQL database. Running HONC with a D1 database involves two key steps: first, setting up the project locally, and second, deploying it in production. You can spin up your D1 database locally using Wrangler. If you're planning to deploy your application for production use, ensure that you have created a D1 instance in your Cloudflare account.
911

0 commit comments

Comments
 (0)