Skip to content

EthanCoderPenguin2012/minimal-chef

Repository files navigation

Minimal Chef

License: MIT Vercel React Material-UI

A minimalist cooking companion app built with React and Material-UI.

[!NOTE]

Features

  • Recipe Management: Browse and search your recipe collection
  • Discover: Explore new recipes from various cuisines
  • Shopping List: Organized grocery list with categories
  • Dark/Light Mode: Toggle between themes
  • Responsive Design: Works on desktop, tablet, and mobile
  • Material 3 Design: Clean, minimalist interface

Design Specifications

  • Light Mode: Base color #EADDCB
  • Dark Mode: Base color #203141
  • Typography: Times New Roman for headings, Noto Sans for body text
  • Layout: Hideable sidebar on desktop, bottom navigation on mobile
  • FAB: Floating action button for quick actions

Getting Started

  1. Clone the repository:

    git clone https://github.com/EthanCoderPenguin2012/minimal-chef.git
    cd minimal-chef
  2. Install dependencies:

    npm install
  3. Set up environment variables:

    cp .env.example .env

    Edit .env and add your Claude API key:

    REACT_APP_ANTHROPIC_API_KEY=your_actual_api_key_here
    
  4. Start the development server:

    npm start
  5. Open http://localhost:3000 to view it in the browser.

Deployment

This app is configured for automatic deployment to Vercel:

  1. Fork this repository
  2. Connect your GitHub repository to Vercel
  3. Vercel will automatically deploy on every push to main
  4. Add your REACT_APP_ANTHROPIC_API_KEY in Vercel's environment variables
  5. Your app will be available at your Vercel domain

Manual Deployment

To deploy manually:

npm run build
# Then upload the build folder to your hosting provider

API Configuration

To use AI recipe generation, you need a Claude API key from Anthropic:

  1. Sign up at console.anthropic.com
  2. Create an API key
  3. Add it to your .env file as REACT_APP_ANTHROPIC_API_KEY

Note: For Vercel deployment, add your API key as an environment variable in your Vercel dashboard under Settings > Environment Variables.

Features

Recipe Management: Browse and search recipes
Discover: Explore international cuisines
Shopping List: Categorized grocery lists
Meal Logging: Track daily meals and calories
AI Recipe Generation: Claude-powered recipe creation
Voice Chef: Step-by-step voice instructions
Recipe Import: Import from URLs with serving adjustment
Manual Recipe Creation: Build custom recipes
International Database: Recipes from multiple countries
Recipe Timer: Multiple simultaneous cooking timers
Nutrition Tracker: Daily macro and calorie tracking
Recipe Roulette: Random recipe suggestions with filters
Dark/Light Mode: Theme switching
Responsive Design: Mobile and desktop optimized
Analytics & Speed Insights: Vercel performance tracking

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Quick Start for Contributors

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

Community

Support

If you find this project helpful, please give it a ⭐ on GitHub!

For questions or support, please open an issue.

License

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