A mobile-first PWA for scanning, recording, and rating menu items from restaurants, bars, and more. Built with Next.js, TailwindCSS, Shadcn UI, Kysely, Prisma, Lucia, React Hook Form, Arktype, and more.
/ (root)
/app # Next.js app directory (pages, layouts, routing)
/components # Reusable React components (with Storybook stories)
/db # Kysely DB client, Prisma schema/migrations
/lib # Utility functions, hooks, helpers
/public # Static assets (favicons, images)
/styles # Tailwind config, global styles
/tests # Vite unit/integration tests
/docs # Project documentation
- Biome: Linting and formatting
- Knip: Unused code detection
- Vitest: Unit/integration testing
- Storybook: UI component development/testing
- PNPM: Package management
- GitHub Actions: Runs Biome, Knip, Vitest, and Storybook build on every push/PR to
main.
pnpm biome check .— Lint and format checkpnpm knip --strict— Unused code checkpnpm vitest run --coverage— Run all tests with coveragepnpm storybook— Run Storybook locallypnpm build-storybook— Build Storybook static site
- Copy
.env.exampleto.envand fill in your secrets (Postgres, API keys, etc.)
See the /docs folder for full planning, architecture, and tech stack details.
First, run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun devOpen http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.
This project uses next/font to automatically optimize and load Geist, a new font family for Vercel.
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.