Skip to content

LeanneCodes/global-grub-hub

Repository files navigation

Global Grub Hub

Global Grub Hub is a recipe collection application that allows users to explore popular cuisines from around the world in one spot. Discover diverse international dishes, find new recipes, and experience global flavors all in one place.

Application Appearance

Web Application

Table of Contents

Features

  • Browse recipes by cuisine
  • View detailed recipe information, including ingredients, instructions, and nutrition facts
  • Favorite recipes to save them for later
  • Responsive design for mobile and desktop

Upcoming Features

  • Users will be able to search for recipes within the Tasty API
  • Users can share recipes with friends and family via social media or plain links

Technologies

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/global-grub-hub.git
    cd global-grub-hub
  2. Install dependencies:

    npm install

Usage

  1. Create a .env.local file in the root directory and add your Tasty API key:

    NEXT_PUBLIC_TASTY_API_KEY=your_api_key_here
  2. Run the development server:

    npm run dev

    Open http://localhost:3000 with your browser to see the result.

Environment Variables

The project uses environment variables to manage sensitive information. Make sure to set the following variables in your .env.local file:

  • NEXT_PUBLIC_TASTY_API_KEY: Your Tasty API key.

Deployment

The project is configured to be deployed on Vercel. Follow these steps to deploy:

  1. Install the Vercel CLI globally:

    npm install -g vercel
  2. Log in to your Vercel account:

    vercel login
  3. Initialize the project with Vercel:

    vercel

    Follow the prompts to link your project to a Vercel project.

  4. Set up environment variables in the Vercel dashboard:

    • Go to the Vercel Dashboard.
    • Select your project.
    • Navigate to the "Settings" tab.
    • Under "Environment Variables", add NEXT_PUBLIC_TASTY_API_KEY with your API key value.
  5. Deploy the project:

    vercel --prod

Contributing

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

License

This project is licensed under the MIT License. See the LICENSE file for more details.

About

Worldwide recipes fetched from an API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published