jr/cooking
1
0
Fork 0
mirror of https://github.com/runyanjake/cooking.git synced 2026-03-26 01:43:17 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
whitney 2026-03-02 22:23:08 -08:00
parent 80ad9e291c
commit 7cf7b9572d
1 changed files with 10 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,21 +1,20 @@
# cooking # cooking
A content-first personal recipe site. No popups, no life stories — just recipes. A content-first personal recipe site.
**Live site:** [recipes.whitney.rip](https://recipes.whitney.rip) **Live site:** [recipes.whitney.rip](https://recipes.whitney.rip)
## Stack ## Stack
- **Next.js 15** (App Router, SSG, standalone output) - **Next.js**, **TypeScript** + **Tailwind CSS**
- **TypeScript** + **Tailwind CSS** - **MDX** with YAML frontmatter metadata.
- **MDX** with YAML frontmatter for recipe content - **next-mdx-remote/rsc** + **remark-gfm** for server-side compilation/rendering.
- **next-mdx-remote/rsc** + **remark-gfm** for server-side MDX compilation - No database — recipes are checked into the repo.
- No database — recipes are MDX files on disk
## Project Structure ## Project Structure
``` ```
app/ # Next.js App Router pages app/
page.tsx # Homepage page.tsx # Homepage
recipes/ recipes/
page.tsx # Recipe listing with search/filter page.tsx # Recipe listing with search/filter
@ -27,7 +26,7 @@ lib/
recipes.ts # Recipe loader (reads from public/recipes/) recipes.ts # Recipe loader (reads from public/recipes/)
public/ public/
assets/ # Site-level SVGs assets/ # Site-level data.
authors.json # Author metadata authors.json # Author metadata
recipes/ # All recipe content (MDX + images colocated) recipes/ # All recipe content (MDX + images colocated)
[category]/ [category]/
@ -81,7 +80,7 @@ Intro prose (rendered above the card).
*Caption text* *Caption text*
## Ingredients ## Ingredients
- 1 cup lentils - 1 cup short grain rice
## Instructions ## Instructions
1. Rinse and cook. 1. Rinse and cook.
@ -98,23 +97,14 @@ Optional credits.
```bash ```bash
npm install npm install
npm run dev # http://localhost:3000 npm run dev # 3000
npm run build npm run build
npm run lint npm run lint
``` ```
## Docker ## Deployment
Build and run with Docker Compose (deploys behind a Traefik reverse proxy):
```bash
docker compose up -d --build
```
To rebuild from scratch:
```bash ```bash
docker compose down && docker system prune -f && docker compose up -d --build && docker logs -f recipes docker compose down && docker system prune -f && docker compose up -d --build && docker logs -f recipes
``` ```
The container runs on port 3000. Traefik handles TLS termination via Let's Encrypt.