Skip to content

BHAV0207/Recipe-Realm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 

Repository files navigation

RecipeRealm 🍳

RecipeRealm is a modern React application that helps users discover, save, and manage recipes while tracking their nutritional goals. Built with React and Vite, it offers a seamless experience for cooking enthusiasts.

Features 🌟

  • Recipe Discovery: Browse and search through a vast collection of recipes
  • Favorites: Save your favorite recipes for quick access
  • Collections: Organize recipes into custom collections
  • Meal Planning: Plan your weekly meals with an interactive calendar
  • Nutrition Tracking: Monitor your nutritional intake and set dietary goals
  • Rating System: Rate recipes and add personal notes
  • Responsive Design: Fully responsive interface that works on all devices

Technologies Used 💻

  • React 18.3
  • Vite
  • React Router DOM
  • TailwindCSS
  • React Icons
  • React Markdown
  • React Rating Stars Component

Getting Started 🚀

Prerequisites

  • Node.js (v14 or higher)
  • npm or yarn

Installation

  1. Clone the repository:

    git clone https://github.com/BHAV0207/Recipe-Realm
    cd recipe
  2. Install dependencies:

    npm install
  3. Start the development server:

    npm run dev
  4. Open your browser and visit http://localhost:5173

Available Scripts 📝

  • npm run dev - Starts the development server
  • npm run build - Builds the app for production
  • npm run lint - Runs ESLint to check code quality
  • npm run preview - Previews the production build locally

Project Structure 📁

@recipe give me a proper readme for this

I'll help you create a comprehensive README.md for your RecipeRealm project. Here's a well-structured version: bash git clone [your-repository-url] cd recipe bash npm install bash npm run dev recipe/ ├── src/ │ ├── Components/ # Reusable UI components │ ├── Pages/ # Page components │ ├── Functions/ # Utility functions │ ├── utils/ # Helper utilities │ ├── App.jsx # Main application component │ └── main.jsx # Application entry point ├── public/ # Static assets └── ...config files

Contributing 🤝

  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 🙏

  • Vite for the blazing fast build tool
  • React for the awesome UI library
  • TailwindCSS for the utility-first CSS framework

Releases

No releases published

Packages

No packages published

Languages