potluck: README sells and gets to TADA; CONTRIBUTING has the rest
The README was EmDash's template blurb. Now it says what potluck is and its first block runs from a fresh clone to /issues, using a new `pnpm seed:issues` script that applies seed/issues.json to the local D1 database. CONTRIBUTING covers how it's put together, seeds, checks, the EmDash rules, and deploying; the template's stale notes (Inter, three-column articles) are gone. AGENTS.md is now a symlink to it. Generated-by: Claude Opus 5.5
This commit is contained in:
1 parent
002f08b456
commit
8a812d76e3
4 files changed
+107
-169
No files matched your search
+19
-61
@@ -1,68 +1,26 @@
|
||||
# EmDash Blog Template (Cloudflare)
|
||||
# potluck
|
||||
|
||||
A clean, minimal blog built with [EmDash](https://github.com/emdash-cms/emdash) and deployed on Cloudflare Workers with D1 and R2.
|
||||
A weekly zine of what you found elsewhere: each issue is one ISO week
|
||||
(`/issues/2026-w40`) of bookmarks with a few words of editorial around
|
||||
them. Everyone brings a dish. The bookmarks come from your own diigo
|
||||
account, so the web you read becomes something you publish on your own
|
||||
site ([PESOS](https://indieweb.org/PESOS)). For now issues are put
|
||||
together by hand. Pulling a week from diigo-cache is next.
|
||||
|
||||
[](https://deploy.workers.cloudflare.com/?url=https://github.com/emdash-cms/templates/tree/main/blog-cloudflare)
|
||||
Plain HTML that's easy to read, with
|
||||
[microformats](https://microformats.org/wiki/h-entry) so feed readers
|
||||
and IndieWeb tools see each issue as an `h-entry` and each bookmark as
|
||||
an `h-cite`. It's an [EmDash](https://docs.emdashcms.com/) site, so you
|
||||
edit issues in a real admin UI, and it runs on Cloudflare Workers.
|
||||
|
||||

|
||||
## Getting started
|
||||
|
||||
## What's Included
|
||||
|
||||
- Featured post hero on the homepage
|
||||
- Post archive with reading time estimates
|
||||
- Category and tag archives
|
||||
- Full-text search
|
||||
- RSS feed
|
||||
- SEO metadata and JSON-LD
|
||||
- Dark/light mode
|
||||
|
||||
## Pages
|
||||
|
||||
| Page | Route |
|
||||
|---|---|
|
||||
| Homepage | `/` |
|
||||
| All posts | `/posts` |
|
||||
| Single post | `/posts/:slug` |
|
||||
| Category archive | `/category/:slug` |
|
||||
| Tag archive | `/tag/:slug` |
|
||||
| Search | `/search` |
|
||||
| Static pages | `/pages/:slug` |
|
||||
| 404 | fallback |
|
||||
|
||||
## Screenshots
|
||||
|
||||
| | Desktop | Mobile |
|
||||
|---|---|---|
|
||||
| Light |  |  |
|
||||
| Dark |  |  |
|
||||
|
||||
## Infrastructure
|
||||
|
||||
- **Runtime:** Cloudflare Workers
|
||||
- **Database:** D1
|
||||
- **Storage:** R2
|
||||
- **Framework:** Astro with `@astrojs/cloudflare`
|
||||
|
||||
## Local Development
|
||||
|
||||
```bash
|
||||
```sh
|
||||
pnpm install
|
||||
pnpm dev
|
||||
pnpm dev # open http://localhost:4321/_emdash/admin, finish the setup wizard, then Ctrl-C
|
||||
pnpm seed:issues # three sample issues, W38–W40 of 2026
|
||||
pnpm dev # → http://localhost:4321/issues
|
||||
```
|
||||
|
||||
Open http://localhost:4321/_emdash/admin and complete the setup wizard. EmDash runs database migrations and applies the blog seed during setup. The site is available at http://localhost:4321.
|
||||
|
||||
## Deploying
|
||||
|
||||
```bash
|
||||
pnpm wrangler login
|
||||
pnpm deploy
|
||||
```
|
||||
|
||||
The first deployment provisions the named D1 database and R2 bucket from `wrangler.jsonc`. See [Deploy to Cloudflare](https://docs.emdashcms.com/deployment/cloudflare/) for production setup, or use the deploy button above.
|
||||
|
||||
## See Also
|
||||
|
||||
- [Node.js variant](../blog) -- same template using SQLite and local file storage
|
||||
- [All templates](../)
|
||||
- [EmDash documentation](https://docs.emdashcms.com/)
|
||||
Next: [CONTRIBUTING](CONTRIBUTING.md) covers how it's put together,
|
||||
checks, and deploying.
|
||||
Reference in new issue
Block a user