/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 LanguageRubyMIT LicenseMIT

My Favourite Recipes App

📗 Table of Contents

📖 My Favourite Recipes app

My Favourite Recipes 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. Also, since sharing recipes is an important part of cooking the app should allow you to make them public so anyone can access them. 🧑‍🍳👨‍🍳👩‍🍳🧑‍🔬🍳🍚🍪🍕🍴

🛠 Built With

Tech Stack

  • Ruby
  • PostgreSQL

Key Features

  • Use of Ruby on Rails framework.
  • Use Ruby Gems as a software packages system
  • Understand what ORM is
  • Use database migration files to maintain database schema.
  • Understand Rails RESTful design and router.
  • Secure app from n+1 problems.
  • Use validations for models.
  • Set up associations between models.
  • Write integration tests with capybara gem.

(back to top)

💻 Getting Started

Follow these steps in order to run ruby code.

Prerequisites

First, you need to ensure that you have Rails and Ruby installed on your computer.

Setup

It varies depending on your operating system so here are some links to help you install it on Windows and on Ubuntu.

For MacOS run the following commands

  brew install rbenv ruby-build
  # Add rbenv to bash so that it loads every time you open a terminal
  echo 'if which rbenv > /dev/null; then eval "$(rbenv init -)"; fi' >> ~/.bash_profile
  source ~/.bash_profile

  # Install Ruby
  rbenv install 3.0.1
  rbenv global 3.0.1
  ruby -v

This example shows how to install Ruby 3.0.1 which was the latest version in April 2021, but you can check to see if there is a newer version here. Iy is also assumed that you have homebrew already installed on your Mac.

Usage

Once you have ruby installed, clone this repository

To run the project, execute the following command in the terminal:

bundle install

rails server

In your preferred browser, navigate to:

http://localhost:3000

Run tests

To run tests, run the following command in the terminal:

rspec

👥 Authors

👤 Nshanji Hilary Ndzi

👤 Oscar Villagran

(back to top)

🔭 Future Features

The following are the future features that will be added to the project.

  • Add API endpoints.
  • Add images and videos section.

(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 you can give us a hand by recommending either one of us to potential employers! 😉🤝

(back to top)

🙏 Acknowledgments

We would like to thank those who have motivated us to keep on fighting despite how tough the journey may become.

(back to top)

📝 License

This project is MIT licensed.

(back to top)