ankitt26/Recipe-app

The Recipe app keeps track of all your recipes, ingredients, and inventory. It will allow you to save ingredients, keep track of what you have, create recipes, and generate a shopping list based on what you have and what you are missing from a recipe.

📖 Recipe App

📗 Table of Contents

• 📗 Table of Contents
• 📖 Recipe App
  • 🛠 Built With
    • Key Features
  • 🚀 Live Demo
  • Getting Started
    • Prerequisites
    • Usage
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 Recipe App

Recipe App: This project employs a Ruby on Rails app with PostgreSQL database. It allows users to add food, inventory, recipes, inventory foods and recipe foods. Ensured accurate migrations and data relationships as per ERD diagram. 📚

🛠 Built With

• Ruby
• Ruby On Rails
• PostgreSQL

Key Features

• Has inventory details page that leads to a form that allows users to add new food.
• Has recipe details page that has a modal to choose an inventory to create a shopping list with
• Has inventory shopping list that shows the list of food that is missing by comparing the food in the recipe with the food in the inventory.
• Has inventory shopping list that counts the total food items and total price of the missing food.
• Display Recipes
• Create or Remove Food item
• Create or Remove Recipe item
• Create or Remove Inventory item
• Validation & Unit Tests
• Controllers
• Views
• Add Forms
• Capybara tests
• Add devise
• Add authorization

(back to top)

🚀 Live Demo

🎉 see live

(back to top)

Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• A basic understanding of Ruby, Rails and Git

Usage

1. Install Ruby
2. Install Rails
3. Clone this repo

git clone git@github.com:ankitt26/Recipe_app.git

To run the project, execute the following command:

  rails s

To run tests, run the following command:

bundle exec rspec spec

(back to top)

👥 Authors

👤 Kodjo-Sarso Tetteh

• GitHub: @Reggeditt
• LinkedIn: LinkedIn

👤 Ankit Kushwaha

• GitHub: @githubhandle
• LinkedIn: LinkedIn

👤 Charles Andrews

• GitHub: @githubhandle
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Modern UI

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Please support this project and be a part of something meaningful and impactful. Your contribution can make a significant difference and help us achieve our goals faster.

(back to top)

🙏 Acknowledgments

Grateful to all for inspiring codebases, your dedication and creativity made a lasting impact on our success. Thank you!

(back to top)

❓ FAQ

• Can I fork and reuse this repository?

Absolutely! Please feel free to fork and reuse this repository for your own projects.

• Is it okay to improve this repository? Will my changes be accepted?

Definitely! We welcome any improvements or new ideas you may have. If your changes are good and align with the project's goals, we would be happy to accept them.

(back to top)

📝 License

This project is MIT licensed.

(back to top)