Recipe App

An app to keep track of all your recipes, ingredients, and inventory.

Table of Contents

• About the Project
  • Built With
  • Live Demo
• Getting Started
  • Prerequisites
  • Installation
  • Usage
  • Testing
  • Deployment
• Authors
• Future Features
• Contributing
• Show Your Support
• Acknowledgements
• License

About the Project

The Recipe App keeps track of all your recipes, ingredients, and inventory. It allows 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. Also, since sharing recipes is an important part of cooking, the app allows you to make them public so anyone can access them.

Built With

The Recipe App was built with:

• Ruby On Rails
• PostgreSQL

Live Demo

You can view a live demo of the Recipe App at COMING SOON.

Getting Started

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

Prerequisites

To run this project, you'll need to install:

• Ruby 2.7.0 or later
• Rails 6.0 or later
• PostgreSQL

Installation

1. Clone this repository to your desired folder:

git clone [email protected]:manq2010/recipe-app.git

cd recipe-app

2. Install the required gems:

bundle install

3. Set up the database:

rails db:create

rails db:migrate

Usage

To run the project, execute the following command:

rails server

Testing

To run tests, run the following command:

bundle exec rspec

Deployment

You can deploy this project using:

• Heroku
• AWS Elastic Beanstalk
• Other cloud hosting providers

Authors

👤 Ibrahim Suhail Al-Yousefi

• GitHub: @cluab
• Twitter: @cluab122
• LinkedIn: Ebrahim Al-Yousefi
• Instagram: @27.i.b

👤 Mancoba Sihlongonyane

• GitHub: @manq2010
• Twitter: @mancoba_c
• LinkedIn: mancobasihlongonyane

Future Features

• Add a meal planner to help users plan their weekly meals.
• Allow users to add pictures to their recipes.

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

Show Your Support

Give a ⭐️ if you like this project!

Acknowledgements

• Microverse for providing the education that inspired this project.
• RailsGuides for the excellent documentation on Ruby on Rails.

License

This project is licensed under the MIT License - see the LICENSE file for details.