Welcome to RecipeApp — a React-based application where you can explore, search, and save delicious recipes from various cuisines. Whether you're a beginner cook or an experienced chef, RecipeApp helps you find inspiration for your next meal!
- 🔍 Search Recipes: Easily search for recipes by ingredients or meal types
- ⭐ Save Favorites: Bookmark your favorite recipes for quick access
- 🥗 Explore Cuisines: Discover a wide range of cuisines from different cultures
- 📱 Responsive Design: Access RecipeApp seamlessly on both desktop and mobile
- Node.js installed
- Git installed
-
Clone the repository:
git clone https://github.com/rudalkunwar/recipe-app.git
-
Navigate to the project directory:
cd recipe-app
-
Install dependencies:
npm install
-
Run the app locally:
npm start
-
Open in browser:
- Visit http://localhost:3000
To integrate with the recipe API:
- Obtain an API key from Spoonacular (or your preferred recipe API)
- Create a
.env
file in the project root:REACT_APP_API_KEY=your_api_key_here
- React.js: Frontend framework
- Axios: API client
- CSS Modules/Tailwind CSS: Styling
- Spoonacular API: Recipe data source
We welcome contributions! Here's how to get started:
- Fork the repository
- Create a feature branch:
git checkout -b feature-name
- Make your changes
- Stage and commit:
git add . git commit -m "Description of changes"
- Push to your fork:
git push origin feature-name
- Submit a pull request
- Check existing Issues or create new ones
- Wait for issue assignment before starting work
- Fork the repository
- Create a new branch for your feature
- Make changes and test thoroughly
- Include screenshots with pull requests where relevant
flowchart LR
Fork[Fork the project]-->branch[Create a New Branch]
branch-->Edit[Edit file]
Edit-->commit[Commit the changes]
commit -->|Finally|creatpr((Create a Pull Request))
We're participating in Hacktoberfest 2024! Look for issues labeled hacktoberfest
to contribute. All valid pull requests are welcome!
New to Git and GitHub? Check out these helpful articles:
Please note that this project follows a Contributor Code of Conduct. By participating in this project online or at events, you agree to abide by its terms.
This project is licensed under the MIT License - see the LICENSE file for details.
A heartfelt thank you to the following individuals for their valuable contributions to RecipeApp. Your support and dedication are greatly appreciated:
⭐ Give us a star if this project helped you!
Happy Cooking! 🍳👩🍳👨🍳