Skip to content

Latest commit

 

History

History
69 lines (53 loc) · 2.84 KB

README.md

File metadata and controls

69 lines (53 loc) · 2.84 KB
Raw

Icook - Interactive Cooking Website

Icook Logo

Icook is an interactive web application designed to make cooking a seamless and enjoyable experience. Users can browse through a variety of recipes, get detailed instructions for preparing dishes, and engage in a step-by-step cooking guide.

Key Features

  • Recipe Browsing: Users can explore a curated list of recipes on the homepage.
  • Detailed Instructions: Each recipe comes with comprehensive preparation steps and ingredient lists.
  • Interactive Cooking Guide: The CookWithMe feature guides users through the cooking process with a visual progress bar.
  • Responsive Design: Optimized for various device sizes, providing a consistent user experience across desktops, tablets, and mobile devices.
  • Accessibility: Navigation controls and UI elements are designed to be accessible and user-friendly.

Technologies Used

  • React: A JavaScript library for building user interfaces with component-based architecture.
  • Tailwind CSS: A utility-first CSS framework for styling the application.
  • React Router: A standard library for routing in React, allowing navigation between different components.

Components

  • App.jsx: The root component that renders the entire application and sets up routing.
  • Head.jsx: Displays the site's header, including the brand logo and navigation link to the home page.
  • NavigationBar.jsx: Allows users to navigate through the website with back and home buttons.
  • Tail.jsx: Renders the website's footer with copyright and acknowledgment information.
  • RecipesList.jsx: Lists all recipes in a grid layout for users to select from.
  • Recipe.jsx: Provides detailed information about the selected recipe.
  • CookWithMe.jsx: Offers an interactive cooking session for the chosen recipe.

Setup and Installation

  1. Clone the repository: 
    git clone https://github.com/yourusername/Icook.git
  2. Navigate to the project directory: 
    cd Icook
  3. Install the dependencies: 
    npm install
  4. Run the application: 
    npm start
    This will launch the Icook website on localhost:3000.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  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

Project Link: https://github.com/YuvalRozner/Icook

Acknowledgments

All contributors who participated in this project:

  • Dor Shabat
  • Nitzan Ezra
  • Yuval Rozner
  • Niv Dahann