Skip to content

Latest commit

 

History

History
59 lines (49 loc) · 2.98 KB

README.md

File metadata and controls

59 lines (49 loc) · 2.98 KB
Raw

Recipe Keeper

A delightful web application where you can collect and organize all your favorite recipes. Picture yourself effortlessly browsing through recipes, adding new ones, and sharing culinary delights with your friends and family. Let the cooking adventures begin!

How to use:

  • Register to our web app.
  • Verify your account.
  • Browse recipes available to our platform and you are good to go.

Pages :

  1. Home Page: Set the stage with a warm welcome and a tantalizing glimpse of what’s to come. Include a navigation bar guiding users through the app.
  2. Recipes Page: Display a collection of recipes with essential details like the dish name, cuisine type, and a mouthwatering photo. Each recipe should be clickable for detailed viewing.
  3. Add Recipe Form: Create a user-friendly form for adding new recipes. Include fields for the recipe name, ingredients, cooking instructions, and any additional notes.
  4. Search Functionality: Implement a search feature allowing users to find recipes by name or cuisine type.

Technologies Used :

  • Reactjs : A JavaScript library for building user interfaces.
  • Redux : A predictable state container for JavaScript apps, used for state management.
  • Tailwind CSS: A utility-first CSS framework for rapidly building custom user interfaces.
  • Material UI: A popular React UI framework with a comprehensive set of components.
  • Node.js: A JavaScript runtime built on Chrome's V8 JavaScript engine, used for server-side development.
  • Express: A minimal and flexible Node.js web application framework.
  • Mongoose: An elegant MongoDB object modeling tool for Node.js.
  • MongoDB: A NoSQL database for storing and managing data.

PaaS Used :

  • Github : Used git and github for version controlling for our project.
  • Netlify : For hosting frontend code.
  • Render : For creating web server.

Contribute :

  1. Fork this repo
  2. Clone this repo in your local machine
  3. Contribute your changes
  4. Create a Pull Request

MIT License

Copyright (c) [2024] [Recipe Keeper]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.