aadit/sindhi-menu
1
0
Fork 0
mirror of https://github.com/aaditagrawal/sindhi-menu.git synced 2026-02-01 18:31:33 +05:30
Code Issues Projects Releases Packages Wiki Activity
No description
58 commits 2 branches 0 tags 878 KiB
Find a file
Exact
sherlock 4d257ea4d5 fix: if this doesn't work on cf it's so over
2026-01-05 23:12:08 +05:30
.playwright-mcp Updated menus, added fixes to the viewer 2025-10-17 19:05:02 +05:30
public fix: Full week menu should work now 2026-01-05 22:25:05 +05:30
src fix: api updated and full week should work (and build on cloudflare hopefully lol) 2026-01-05 23:07:12 +05:30
worker fix: if this doesn't work on cf it's so over 2026-01-05 23:12:08 +05:30
.gitignore Initial commit from Create Next App 2025-08-19 02:50:21 +05:30
bun.lock Update lockfile 2026-01-05 23:09:54 +05:30
components.json new fix 2025-08-19 03:17:26 +05:30
CONTRIBUTING.md Added updated links 2025-09-16 02:43:38 +05:30
eslint.config.mjs Initial commit from Create Next App 2025-08-19 02:50:21 +05:30
IMPLEMENTATION_GUIDE.md Updated menus, added fixes to the viewer 2025-10-17 19:05:02 +05:30
LICENSE added the MIT license 2025-08-25 09:20:10 +05:30
MENU_MANAGER.md Updated menus, added fixes to the viewer 2025-10-17 19:05:02 +05:30
next.config.ts fix: api updated and full week should work (and build on cloudflare hopefully lol) 2026-01-05 23:07:12 +05:30
package-lock.json fix: api updated and full week should work (and build on cloudflare hopefully lol) 2026-01-05 23:07:12 +05:30
package.json fix: api updated and full week should work (and build on cloudflare hopefully lol) 2026-01-05 23:07:12 +05:30
postcss.config.mjs Initial commit from Create Next App 2025-08-19 02:50:21 +05:30
README.md Added updated links 2025-09-16 02:43:38 +05:30
tsconfig.json Initial commit from Create Next App 2025-08-19 02:50:21 +05:30
wrangler.jsonc fix: api updated and full week should work (and build on cloudflare hopefully lol) 2026-01-05 23:07:12 +05:30

README.md

Sindhi Menu

Sindhi Menu is a fast, friendly viewer for the Sindhi Mess weekly menu. It ships with a curated JSON snapshot of the mess banner and renders a week-at-a-glance experience that keeps track of the current time in Indian Standard Time (IST).

Overview

  • Static-first data – all meals are sourced from public/sindhi-menu.json and baked into the build.
  • Time aware – detects the current or upcoming meal in IST and scrolls/highlights it automatically.
  • Responsive card UI – swipeable carousel on smaller screens, transposed grid on large displays.
  • Accessible theming – light and dark palettes with readable chips for special veg / non-veg sections and a manual theme toggle.

Tech Stack

  • Next.js App Router (SSG + ISR) with TypeScript
  • Tailwind CSS v4 with CSS variables for themes
  • next-themes for runtime theme switching
  • shadcn-inspired UI primitives (Card, Button) and lucide-react icons

Getting Started

Requirements

  • Node.js 18+
  • Bun
bun install
bun run dev

Visit http://localhost:3000. The current week is generated from the JSON file each time the server starts.

Production build

bun run build
bun run start

Linting

bun run lint

Updating Menu Data

  1. Edit public/sindhi-menu.json with the latest banner contents.
  2. Keep each meal’s specialVeg, veg, and nonVeg entries as strings or arrays. Multi-item strings can be comma/newline/semicolon separated; the loader splits them automatically.
  3. Run bun run dev locally and verify the Tuesday dinner (dinners often expose the splitting) plus light/dark themes.
  4. Commit the JSON along with any related UI tweaks.

Project Structure

  • src/app/ – Route handlers, layouts, and pages (home view and full-week view)
  • src/components/ – UI components such as the carousel, cards, selectors, notifications
  • src/data/weeks/ – Static week builder that transforms the JSON snapshot into typed menu objects
  • src/lib/ – Shared utilities (IST date helpers, exceptions filter, type definitions)
  • public/ – Static assets, including the menu JSON and icons

Design Notes

  • Cards flatten sections so veg and non-veg items can sit side-by-side while still conveying kind through iconography and color.
  • Theme colors are defined once in src/app/globals.css with CSS variables, and the body picks up the appropriate color-scheme.
  • Accessibility considerations include keeping section metadata through aria-labels even when headings are hidden.

Future Ideas

  • Add other messes or user-provided menus once reliable data sources exist.
  • Allow personal annotations or alerts for favourite dishes.
  • Automate JSON updates from banner photos via OCR.

Deployment

Any Node-compatible host (Vercel, Fly.io, Render, etc.) will work. Build with bun run build and serve with bun run start. Because the data is static, no additional runtime configuration is required.