Skip to content

This is the group capstone project in the fifth module of the Microverse program. It is a food recipes app built using Ruby on Rails.

License

Notifications You must be signed in to change notification settings

mahammad-mostafa/food-recipes

Repository files navigation

🏷️ Food Recipes

This is the group capstone project of the fifth module in the Microverse program.
Check the below contents for further details about this project.

📗 Contents

📖 Description

This repository is about a recipes app with food items & shopping list. Porject is built using Rails framework with Ruby. It is configured to use PostgreSQL database. Integration tests using Capybara gem. Authentication using Devise gem. Authorization using CanCanCan gem. Pagination using kaminari gem. Optimized queries with bullet gem.

📌 Live Demo:

  • Check the project live from here

📌 Tech Stack:

  • Programming language is Ruby
  • Database used is PostgreSQL
  • Framework used is Rails
  • Tests done with RSpec

📌 Key Features:

  • Responsive layout with all screen sizes
  • User authentication is required first (email / password)
  • Navigation menu with links (home / All recipes / My foods / My recipes)
  • Only public recipes can be viewed by all users
  • Each food item displays (name / measurement / price)
  • Every recipe contains several food items
  • Each recipe displays (name / description) & time for (preparation / cooking)
  • Recipes can be made public for all visitors or private
  • Any user can delete his own recipes & food items
  • Recipe owners can add their own food items as ingredients
  • Users generates a shopping list with all unused foods items from their own recipes

back to top

🛠️ Instructions

You can easily download or fork this repository and work on it immadiately!

📌 Prerequisites:

  • You need Ruby language & PostgreSQL database installed

📌 Installation:

  • To get all required gem dependencies run
bundle install
  • Create all required databases & table schemas with
rails db:migrate

📌 Development:

  • Run live server using
rails server
  • Manipulate & process models data through
rails console

📌 Tests:

  • Run all unit test with
bundle exec rspec -f d

back to top

👥 Authors

📌 Mahammad:

📌 Derek:

back to top

🔭 Future

Some additional features I may implement in the project:

  • Integrate React framework in frontend
  • Implement (dark / light) theme switch

back to top

🤝🏻 Contributions

Wish to contribute to this project?
Contributions, issues, and feature requests are more than welcome!
Feel free to check the issues page too.

back to top

⭐️ Support

Like this project? Show your support by starring!

back to top

🙏🏻 Acknowledgements

I thank everyone at Microverse for guiding me through this project.

back to top

📝 License

This project is MIT licensed.

back to top