Skip to content

rahulkumarparida/Recipe-App-React

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Here’s a full README.md draft for your project Recipe‑App‑React (React + Vite + Spoonacular API). You’ll need to update specific values (screenshots, live URL, API key instructions, etc.) to reflect your implementation exactly.


Recipe-App-React

A responsive recipe-search web application built using React (via Vite) that leverages the Spoonacular API to fetch and display recipes. Perfect for exploring meals, filtering by categories/ingredients, and viewing recipe details.

🧮 Features

  • Search for recipes by keywords (e.g., “pasta”, “vegan”, “chicken”)
  • Display a list of matching recipes with image, title & brief info
  • View detailed recipe information (ingredients, instructions, nutritional info)
  • Filter or sort recipes (if implemented)
  • Responsive UI (desktop + mobile friendly)
  • Built with React + Vite, using modern tooling (ESLint, etc)
  • Fetches data from the Spoonacular API

🛠 Tech Stack & Key Libraries

  • Framework: React (via Vite)
  • Build tools: Vite
  • Linting: ESLint (and possibly Prettier)
  • API: Spoonacular REST API
  • Styling: (you should fill: CSS Modules / Tailwind / Styled-Components / plain CSS)
  • Deployment: (you should fill: Netlify / Vercel / GitHub Pages)

📁 Project Structure

Recipe-App-React/ │ ├── public/ ← Static assets and public index.html ├── src/ ← Source code │ ├── components/ ← React components (SearchBar, RecipeCard, RecipeDetail etc) │ ├── pages/ ← Main pages (Home, SearchResults, RecipeDetail) │ ├── api/ ← API service functions for Spoonacular │ ├── styles/ ← Styling (CSS / Sass / modules) │ ├── App.jsx │ └── main.jsx ← Entry point ├── .gitignore ├── package.json ├── vite.config.js └── README.md


## 🔧 Installation & Setup

1. Clone the repo:
   ```bash
   git clone https://github.com/rahulkumarparida/Recipe-App-React.git
   cd Recipe-App-React
  1. Install dependencies:

    npm install
    # or
    yarn install
  2. Set up environment variables:

    • Create a .env (or .env.local) file in the root directory

    • Add your Spoonacular API key, for example:

      REACT_APP_SPOONACULAR_API_KEY=your_api_key_here
    • Important: Do not commit your API key; ensure .gitignore excludes your env file.

  3. Run the development server:

    npm run dev
    # or
    yarn dev

    Then open http://localhost:5173 (or whichever port Vite reports) in your browser.

  4. Build for production:

    npm run build
    # or
    yarn build

    And preview with:

    npm run preview

✅ Usage

  • On the home page, use the search bar to enter a meal-keyword or ingredient.
  • Browse the returned list of recipes (image + name + key info).
  • Click a recipe card to open its detailed view: ingredients list, steps/instructions, nutritional info (if available), and maybe an image gallery.
  • Use any filtering or sorting interface you’ve implemented (e.g., vegetarian, gluten-free, under 30 minutes).
  • Enjoy discovering and cooking new meals!

🧩 Future Enhancements

Here are some ways you could improve or expand the project:

  • Add user authentication & saving favourite recipes
  • Add a “shopping list” or “meal planner” feature
  • Integrate charts or data visualisations (for nutritional breakdown)
  • Add caching or local storage to reduce API calls
  • Use TypeScript for stronger typing and better developer experience
  • Improve UI/UX: animations, theme switcher, dark mode
  • Write unit & integration tests using React Testing Library + Jest
  • Deploy the app with CI/CD pipeline and show live demo link

🤝 Contributing

If you’d like to contribute:

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature-xyz)
  3. Commit your changes (git commit -m 'Add feature xyz')
  4. Push to branch (git push origin feature-xyz)
  5. Open a pull request describing your changes

Please ensure your code follows consistent styling and includes tests where appropriate.

📄 License

This project is open-source and available under the MIT License. Feel free to use, modify and distribute.


Happy cooking and coding! 🍳

About

A recipe app made with react library and Spoonacular Api

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors