Skip to content

Latest commit

 

History

History
108 lines (80 loc) · 3.71 KB

README.md

File metadata and controls

108 lines (80 loc) · 3.71 KB

Dishify

GitHub license Expo SDK version Next.js version React Native version Tailwind CSS version tRPC version TypeScript Cloudflare Workers Next.js Deployment Backend Deployment Expo Deployment

Dishify is your AI-powered culinary companion. Enter any dish name for instant recipes, ingredient lists, and smart shopping links. Elevate your cooking with personalized instructions and effortless grocery planning.

Features

  • Instant recipe generation for any dish
  • Detailed ingredient lists
  • Smart shopping links
  • Personalized cooking instructions
  • Effortless grocery planning
  • Cross-platform support (Web, iOS, Android)

Tech Stack

Getting Started

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/kevin-kidd/dishify.git
    cd dishify
  2. Install dependencies:

    bun install
  3. Set up environment variables:

    • Copy .env.example to .env and fill in the required values
  4. Run the development server:

    • For web:

      bun run web
    • For mobile:

      bun run native

Project Structure

  • apps/
    • expo/: Expo mobile app
    • next/: Next.js web app
  • packages/
    • api/: Backend API and database schema
    • app/: Shared application logic
    • ui/: Shared UI components
  • data_utils/: Utility scripts for preparing recipe data for the database and AI model training

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

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

License

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

Acknowledgments