LunchAOS - Lunch Rating & Feedback System

A modern web application for rating lunch experiences, sharing feedback, and discovering the best lunch spots in your building.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v18.0.0 or higher)
• npm (comes with Node.js)
• Git for version control

Optional but Recommended

• Visual Studio Code with extensions:
  • ESLint
  • Prettier
  • Tailwind CSS IntelliSense
  • TypeScript and JavaScript Language Features

Tech Stack

Frontend

• Next.js 14 - React framework for production
• TypeScript - Type-safe JavaScript
• Tailwind CSS - Utility-first CSS framework
• React Hook Form - Form validation
• Zod - TypeScript-first schema validation
• Chart.js - Data visualization
• React Hot Toast - Toast notifications

Backend

• SQLite - Lightweight database
• Drizzle ORM - TypeScript ORM
• better-sqlite3 - SQLite driver

Development Tools

• ESLint - Code linting
• PostCSS - CSS processing
• Autoprefixer - CSS vendor prefixing
• tsx - TypeScript execution

Features

• 🍽️ Lunch Rating & Feedback

  • Rate lunch by taste, variety, and wait time
  • Quick emoji reactions
  • View average ratings

• 🧭 Crowd & Seating Insights

  • Real-time building occupancy
  • Available seating information
  • Interactive crowd heatmap

• 🍰 Food & Dessert Voting

  • Vote for favorite food items
  • Track popular desserts
  • Share lunch photos

• 🏆 Gamification & Leaderboards

  • Earn badges for participation
  • Compete for special titles
  • Track achievements

• 📊 Analytics & Trends

  • Weekly food popularity trends
  • Building-specific insights
  • User engagement metrics

• 👨‍🍳 Admin Dashboard

  • View aggregated feedback
  • Highlight popular dishes
  • Moderate content

Getting Started

1. Install Node.js and npm

   • Visit Node.js website
   • Download and install the LTS version
   • Verify installation:

     node --version
     npm --version

2. Clone the repository

   git clone https://github.com/yourusername/lunchaos.git
   cd lunchaos

3. Install dependencies

   npm install

4. Set up the database

   • Create a CSV file named cafes_food_items.csv with the following columns:

     cafe_id,building,cafe,food_item,ingredients
     

   • Run the database initialization script:

     npx tsx scripts/init-db.ts cafes_food_items.csv

   • This will create the SQLite database and import your data

5. Start the development server

   npm run dev

6. Open your browser

   • Visit http://localhost:3000

Project Structure

lunchaos/
├── src/
│   ├── app/              # Next.js app directory
│   │   ├── api/         # API routes
│   │   ├── page.tsx     # Home page
│   │   ├── layout.tsx   # Root layout
│   │   └── globals.css  # Global styles
│   ├── components/      # React components
│   └── lib/            # Utility functions
│       └── db/         # Database configuration
├── scripts/            # Database scripts
├── public/             # Static assets
├── package.json        # Dependencies and scripts
├── tailwind.config.js  # Tailwind CSS configuration
├── tsconfig.json      # TypeScript configuration
└── README.md          # Project documentation

Development

Available Scripts

• npm run dev - Start development server
• npm run build - Build for production
• npm run start - Start production server
• npm run lint - Run ESLint

Database Development

1. Schema Changes

   • Edit src/lib/db/schema.ts to modify database schema
   • Delete sqlite.db to reset the database
   • Run npx tsx scripts/init-db.ts cafes_food_items.csv to reinitialize

2. API Routes

   • API routes are in src/app/api/
   • Use Drizzle ORM for database queries
   • Example query:

     const items = await db.select().from(foodItems).where(eq(foodItems.cafeId, cafeId))

3. Database Reset

   rm sqlite.db
   npx tsx scripts/init-db.ts cafes_food_items.csv

Code Style

• We use ESLint and Prettier for code formatting
• Follow the TypeScript strict mode guidelines
• Use Tailwind CSS utility classes for styling

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Troubleshooting

Common Issues

1. Node.js version mismatch

   nvm install 18
   nvm use 18

2. Dependencies installation fails

   npm cache clean --force
   rm -rf node_modules
   npm install

3. TypeScript errors

   npm run build
   # Fix any type errors shown

4. Tailwind CSS not working

   npm run dev
   # Ensure PostCSS is properly configured

5. Database errors

   • Ensure the CSV file format matches the schema
   • Check that all required columns are present
   • Verify the database file has write permissions
   • Try resetting the database:

     rm sqlite.db
     npx tsx scripts/init-db.ts cafes_food_items.csv

License

This project is licensed under the MIT License - see the LICENSE file for details.