/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.

Primary LanguageRuby

Recipe App

📗 Table of Contents

📖 Recipe App

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.

🛠 Built With

Tech Stack

Ruby on Rails
Rspec
Capybara
Bootstrap

(back to top)

💻 Getting Started

The result should look similar to the following data model (this is an Entity Relationship Diagram that you are already familiar with). ERD Recipe App

Setup

  1. Ensure you have Ruby 3.2.2 at least, installed on your system. You can check your Ruby version in the terminal by running:
ruby -v
  1. You can clone the project :

Using HTTPS:

git clone https://github.com/ahmedeid6842/Recipe_App.git

Installation

To run this project locally, follow these steps:

  1. Open your terminal or command prompt.

  2. Navigate to the directory where you have cloned or downloaded the Recipe App repository.

  3. Run the following command to install any required dependencies:

bundle install
  1. You need to make sure you have PostgreSQL installed and configured on your local computer beforehand, then create the database for the project:
rails db:create
  1. Now you need to create the tables and relationships that the project needs:
rails db:migrate

Usage

  1. Once the setup is complete, ensure you are still in the directory containing the Recipe App files.

  2. To run the app, execute the following command:

rails s

Tests

To run the tests ensure you are in the directory containing the test files.

  1. Run the tests using the following command:
rspec

(optional) If you have problem with a different version of 'regexp_parser', you can run the tests with the version of the gemfile with this command:

bundle exec rspec
  • All tests should pass without any errors or failures, ensuring that the code and its methods are functioning correctly.

(back to top)

👥 Authors

👤 Ahmed Eid

👤 César Herrera

(back to top)

🔭 Features

  • Create a Database
  • Add Migrations
  • Add Models
  • Add Controllers
  • Add Views
  • Add tests
  • Show Foods at index page
  • Show Recipes by users
  • Show Public Recipes
  • Authentication User
  • Show shopping list

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project give it a star ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for giving us the opportunity to learn and grow as developers and also I like to thank my family, they are all my support. 🌟

(back to top)

📝 License

This project is MIT licensed.

(back to top)